Documentation

Makester's documentation subsystem helps you prepare and maintain your site's project documentation.

Sadly, technical documentation has become an oversight in many projects. Makester's documentation subsystem attempts to reduce the burden of project documentation setup and maintenance that is not bound to a single programming language. It's just Markdown.

Makester documentation leverages the Materials for MkDocs theme.

The Makester documentation subsystem help lists the available commands:

make help-docs

Command Reference

Site Documentation Scaffolding

Create the site documentation directory structure based on Material for MkDocs: Creating your site.

make docs-project-create

If the default settings are accepted, this will create a docs directory under the top level of you project code repository. The minimal content is:

docs
├── docs
│   └── index.md
└── mkdocs.yml

Additions will need to be performed manually by adding new content under the docs directory. Some things you probably want to do in the first instance include:

Change the name of your site's documentation
- Edit the site_name setting in the docs/mkdocs.yml.
Change the theme:
- Unless you are happy the the standard MkDocs default theme, enable the MkDocs material theme. Append the following to docs/mkdocs.yml:
```
theme:
  name: material
```