selfhost-hub/docs/index.md
songtianlun ee39f48a97 docs: add mkdocs configuration and initial documentation
- Introduce mkdocs.yml for site configuration
- Create index.md with basic commands and project layout

These files are essential for generating and serving project documentation, enhancing accessibility and user experience.
2025-04-20 17:22:33 +08: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.