hdknr / note

Markdown Texts

Markdown

• CommonMark Spec
• GitHub Flavored Markdown

Welcome to MkDocs

For full documentation visit mkdocs.org. (github)

Commands

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

• mkdocs serve

$ mkdocs serve

Project layout

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

Link

• https://github.com/hdknr/annotated-django
• https://github.com/hdknr/annotated-js