Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 822 Bytes

Readme.md

File metadata and controls

22 lines (15 loc) · 822 Bytes

MkDocs integrate with mermaid, sequence, flowchart

For full documentation visit mkdocs.org.

According to MkDocs的使用-甘特图, Mkdocs using gantt with mermaid. I changed a little configuration and script for mermaid version 7.x.x.

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.

Project layout

mkdocs.yml          # The configuration file.
docs/
    index.md        # The documentation homepage.
    uml.md          # Some UML chart testing page.
js/
    umlconvert.js   # Integrate external js. Can initial or do some settings here.