Skip to content

SynBioHub/synbiohub2-mkdocs

Repository files navigation

Material Mkdocs Details

getting started

Extension Details

nav weight title casing awesome nav

How To Run

build the docker container

docker build -t my-mkdocs .

run the docker container on localhost:9090

docker run --rm -it -p 9090:8000 -v ${PWD}:/docs my-mkdocs serve -a 0.0.0.0:8000

How To Write

The section names are in the .nav.yml file in its directory. The section is sorted by its directory name but the title in the .nav.yml file is what is displayed.

The Document names are dirived from the file names and put into title case, they can be over ridden with a title: etc in the frontmater. The documents are sorted from lowest weight: to highest.

About

testing mkdocs as an alternative to the custom renderer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •