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

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

Description

Returns a list of all users.

Response 200 OK

[
    {
        "id": 1,
        "name": "Alice",
        "email": "alice@example.com"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/User"
    }
}

GET /users/{id}

Get user by ID

Input parameters

Parameter In Type Default Nullable Description
id path integer No

Response 200 OK

{
    "id": 1,
    "name": "Alice",
    "email": "alice@example.com"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body
{
    "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

Name Type
email string
id integer
name string

Cards test

Zeus

Zeus

Lorem ipsum dolor sit amet.

Athena

Athena

Lorem ipsum dolor sit amet.

Poseidon

Poseidon

Lorem ipsum dolor sit amet.

Artemis

Artemis

Lorem ipsum dolor sit amet.

Ares

Ares

Lorem ipsum dolor sit amet.

Nike

Nike

Lorem ipsum dolor sit amet.

Timeline test

Launch

2022-Q1

First implementation.

New features

2022-Q2

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

More features!

2022-Q3

Lorem ipsum dolor sit amet.

Bugs!

2022-Q4

Lorem ipsum dolor sit amet.

Gantt test

2022
Q1
Q2
March 2022
April 2022
May 2022
W9W10W11W12W13W14W15W16W17W18W19W20W21W22

Definition Phase

Creative Brief
Graphic Design Research
Brainstorming / Mood Boarding

Creation Phase

Sketching
Design Building
Refining

Feedback Phase

Presenting
Revisions

Delivery Phase

Final delivery

table test

Country Address
France 8 Rue St Ferréol - 92190 City: Meudon (Île-de-France)
50 boulevard Amiral Courbet - 94310 Orly (Île-de-France)
...
...
Italy Str. S. Maurizio, 12, 10072 Caselle torinese TO
S.S. Torino-Asti - 10026 Santena (TO)
...
Poland al. Jana Pawła II 22, 00-133 Warszawa
plac Trzech Krzyży 4/6, 00-535 Warszawa
...
...