Skip to content

ACCESS-NRI/mkdoc-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

General Mkdoc Template

A template repository for the deployment of mkdocs for model configuration documentation and tools

Get started...

Clone the repo

Edit the following file replacing mkdoc-template as appropriate and including your relevant files in the table of contents (see next point)

  • mkdoc-template/documentation/mkdocs.yml

Start creating content and putting markdown files here

  • /mkdoc-template/documentation/docs/pages

Default landing page is here

  • mkdoc-template/documentation/docs/pages/index.md

Turn on rendering of GitHub Pages, go to Settings --> Pages --> Build and deployment for Source choose Github Actions.

About

A template repository for the deployment of mkdocs for model configuration documentation and tools

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published