# MkDocs

<https://www.mkdocs.org/>

Project documentation with Markdown.

MkDocs is a **fast**, **simple** and **downright gorgeous** static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the [introductory tutorial](https://www.mkdocs.org/getting-started/), then check the [User Guide](https://www.mkdocs.org/user-guide/) for more information.

[Getting Started](https://www.mkdocs.org/getting-started/) [User Guide](https://www.mkdocs.org/user-guide/)

## Features

### Great themes available

There's a stack of good looking [themes](https://www.mkdocs.org/user-guide/choosing-your-theme) available for MkDocs. Choose between the built in themes: [mkdocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#mkdocs) and [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs), select one of the third-party themes (on the [MkDocs Themes](https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes) wiki page as well as the [MkDocs Catalog](https://github.com/mkdocs/catalog#-theming)), or [build your own](https://www.mkdocs.org/dev-guide/themes/).

### Easy to customize

Get your project documentation looking just the way you want it by [customizing your theme](https://www.mkdocs.org/user-guide/customizing-your-theme/) and/or installing some [plugins](https://www.mkdocs.org/user-guide/configuration/#plugins). Modify Markdown's behavior with [Markdown extensions](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions). Many [configuration options](https://www.mkdocs.org/user-guide/configuration/) are available.

### Preview your site as you work

The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.

### Host anywhere

MkDocs builds completely static HTML sites that you can host on GitHub Pages, Amazon S3, or [anywhere](https://www.mkdocs.org/user-guide/deploying-your-docs/) else you choose.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://book.konstantinsecurity.com/readme/it-magazines/wiki-and-writeups-tools/mkdocs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.