This is a sample repository to test using the MK Docs static site generator to create and deploy documentation.
-
Documentation source files are written in Markdown format.
-
Site formatting is provided by the Material Theme for MkDocs.
-
Additional formatting is provided by Markdown Extensions such as Admonition, CodeHilite, and PyMdown.
-
To view the documentation locally using the live development server, use the
mkdocs servecommand. Then point a browser to: http://127.0.0.1:8000 -
To build and deploy the site to GitHub Pages use the
mkdocs gh-deploycommand. (Make sure to enable GitHub pages in your repository settings.)
To see the deployed documentation for this repository, go to: https://mark-at-kenzan.github.io/mkdocs-test/