Skip to content

Welcome to my documentation site place thing

For full (this website build) 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

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

ie:

graph TD
    A[root dir] --> B[mkdocs.yml]
    A --> C[docs]
    C --> D[index.md]

Created with the help of (as well as chaz and salty from saltbox)

Is there a Discord server for support?

Why, yes there is!.

What if I see a mistake in or have a suggestion about the docs?

Please report any mistakes or suggestions for improving the documentation on our discord or on the Docs Repository, would be much appreciated.

Last update: 2023-05-19
Created: 2023-05-19