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.

Test Mermaid

graph LR
  A[Start] --> B{Error?};
  B -->|Yes| C[Hmm...];
  C --> D[Debug];
  D --> B;
  B ---->|No| E[Yay!];

API Reference

User Endpoints

Sample API 1.0.0

Simple API for testing MkDocs OpenAPI plugin

Endpoints

GET /users

List users

Response 200 OK

[
    {
        "id": 1,
        "name": "Alice",
        "email": "alice@example.com"
    }
]

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/User"
    }
}

GET /users/{id}

Get user by ID

Input parameters

Response 200 OK

{
    "id": 1,
    "name": "Alice",
    "email": "alice@example.com"
}

{
    "type": "object",
    "properties": {
        "id": {
            "type": "integer",
            "example": 1
        },
        "name": {
            "type": "string",
            "example": "Alice"
        },
        "email": {
            "type": "string",
            "example": "alice@example.com"
        }
    }
}

Response 404 Not Found

Schemas

User

Cards test

Zeus

Lorem ipsum dolor sit amet.

Athena

Lorem ipsum dolor sit amet.

Poseidon

Lorem ipsum dolor sit amet.

Artemis

Lorem ipsum dolor sit amet.

Ares

Lorem ipsum dolor sit amet.

Nike

Lorem ipsum dolor sit amet.

Timeline test

Gantt test

table test