A tutorial MkTechDocs project
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
images
sub-directory
.gitignore
README.md
basics.md
build-docs.sh
configuring.md
diagrams.md
footer.htmlt
footer.renderer
header.html
headers-and-footers.md
images.md
include-blocks.md
master.md
mktechdocs.conf
more-information.md
my-groovy-template.gt
my-jinja2-template.pyt
my-jinja2-template.renderer
my.css
mybuildscript.sh
mytemplate.html
pdf-files.md
templates.md
what-is-a-master.md

README.md

ExampleMkTechDocs

This repo contains a tutorial MkTechDocs project, intended to get you up and running with MkTechDocs quickly using Docker or a local installation of MkTechDocs.

It produces this output.

If you plan on browsing directly on GitHub, be sure to click the "Raw" button when you view markdown files so you can see things that GitHub hides after rendering the page.

Building

Docker

git clone https://github.com/jsseidel/GettingStartedWithMkTechDocs
cd GettingStartedWithMkTechDocs
docker run --rm -v $(pwd):/project jsseidel/mktechdocs

Or, use the build-docs.sh script included in this repo:

git clone https://github.com/jsseidel/GettingStartedWithMkTechDocs
cd GettingStartedWithMkTechDocs
build-docs.sh

Local MkTechDocs installation

Start by cloning the MkTechDocs repository:

git clone https://github.com/att/MkTechDocs

Next, you'll need to set up your environment. Please refer to the Setting up your environment section of the MkTechDocs usage guide.

Once the test scripts are working properly, you can build this sample project:

git clone https://github.com/jsseidel/GettingStartedWithMkTechDocs
cd GettingStartedWithMkTechDocs
mktechdocs

Your output in either case will be in getting_started_pages. Note that depending on your docker setup, this directory may be owned by the root user after the build. Local installations of MkTechDocs don't need to worry about this.