Zum Inhalt

The home page (index.md) is your project's welcome mat. It should be concise and compelling. Include:

A Catchy Title

The project's name.

A Brief Description

What the project does.

Key Features

A bulleted list of the main functionalities.

  • Feature 1
  • Feature 2
  • Feature 3

Quick Start

A single, copy-and-paste command to get started.

/docs
├── about/
│ ├── index.md # Includes license info, etc.
│ └── changelog.md # Can be a manual file or a link
├── api-reference.md # Auto-generated via mkdocstrings
├── assets/
│ └── images/
├── community/
│ ├── code_of_conduct.md
│ ├── contributing.md
│ └── faq.md
├── css/
│ └── custom.css
├── developer-guide/
│ └── index.md # Main page for dev setup, architecture, etc.
├── getting-started/
│ └── index.md # Installation and quick start
├── includes/
│ └── abbreviations.md
├── index.md # The main landing page
└── user-guide/
└── index.md # All user-facing features and guides