Welcome Contributors!

For full documentation visit mkdocs.org. And, also, mkdocs material.

Workflow to contribute

docs to help contribute better

• general: logo and icons
• general: color palette
• general: navigation
• handling code blocks
• formatting
• Mathematics

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

Modify or add content to the markdown files in the docs/ directory:

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.