1
Fork 0
mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00
tux/docs/index.md
kzndotsh 3fc6a5ee01 feat(docs): add MkDocs documentation with initial pages
chore(justfile): add commands to serve and build docs using MkDocs
feat(mkdocs.yml): add initial MkDocs configuration with Material theme
chore(pyproject.toml): add mkdocs-material as a dependency for docs group
2024-07-31 01:38:07 +00:00

491 B

Welcome to MkDocs

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

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