Skip to content

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

├── .github/
│   └── workflows/
│       └── ci.yml                # GitHub Actions workflow for CI/CD
├── docs/
│   ├── .authors.yml              # Author information
│   ├── index.md                  # Documentation homepage
│   ├── assets/                   # Images and logos
│   │   ├── mcrun-favicon.png
│   │   └── mcrun-logo-circle.png
│   ├── projects/                 # Project-specific documentation
│   │   ├── attendance-master-code.md
│   │   ├── attendance-semester-code.md
│   │   ├── mcrace-code.md
│   │   ├── membership-list-code.md
│   │   ├── new-member-communications-code.md
│   │   ├── points-email-code.md
│   │   ├── points-system-code.md
│   │   └── projects.md
│   ├── start/                    # Start documentation
│   │   ├── changelog.md
│   │   ├── code-examples.md
│   │   ├── faq.md
│   │   ├── getting-started.md
│   │   ├── setup.md
│   │   ├── syntax.md
│   │   └── typography.md
│   ├── stylesheets/              # Custom stylesheets
│   │   ├── extra.css
│   │   └── extra.scss
├── LICENSE.md                    # Private Use License
├── mkdocs.yml                    # MkDocs configuration file
├── requirements.txt              # Required packages (for pip)