跳转至

Welcome to Ecool Note

Mkdoc usage

For full documentation visit mkdocs.org.

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

Text Only
1
2
3
4
mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Project dependencies

For full documentation of the theme visit mkdocs-material

Commands

  • pip install --upgrade pymdown-extensions mkdocs mkdocs-material mkdocs-glightbox mkdocs-minify-plugin mkdocs-redirects mkdocs-awesome-pages-plugin - Install Mkdocs, the theme and plugins

评论