Files
textual/docs/README.md
2022-02-07 10:24:50 +00:00

539 B

Documentation Workflow

  • Ensure you're inside the virtual environment poetry shell
  • Run the live-reload server using mkdocs serve
  • Create new pages by adding new Markdown files

Commands

  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

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