1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# MkDocs
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], then check the
[User Guide] for more information.
[introductory tutorial]: getting-started.md
[User Guide]: user-guide/README.md
<div class="text-center">
<a href="getting-started.html" class="btn btn-primary" role="button">Getting Started</a>
<a href="user-guide/index.html" class="btn btn-primary" role="button">User Guide</a>
</div>
<div class="pt-2 pb-4 px-4 my-4 bg-body-tertiary rounded-3">
<h2 class="display-4 text-center">Features</h2>
<div class="row">
<div class="col-sm-6">
<div class="card mb-4">
<div class="card-body">
<h3 class="card-title">Great themes available</h3>
<p class="card-text">
There's a stack of good looking <a href="user-guide/choosing-your-theme.html">themes</a> available for MkDocs.
Choose between the built in themes:
<a href="user-guide/choosing-your-theme.html#mkdocs">mkdocs</a> and
<a href="user-guide/choosing-your-theme.html#readthedocs">readthedocs</a>,
select one of the third-party themes
(on the <a href="https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes">MkDocs Themes</a> wiki page
as well as the <a href="https://github.com/mkdocs/catalog#-theming">MkDocs Catalog</a>),
or <a href="dev-guide/themes.html">build your own</a>.
</p>
</div>
</div>
</div>
<div class="col-sm-6">
<div class="card mb-4">
<div class="card-body">
<h3 class="card-title">Easy to customize</h3>
<p class="card-text">
Get your project documentation looking just the way you want it by
<a href="user-guide/customizing-your-theme.html">customizing your
theme</a> and/or installing some <a
href="user-guide/configuration.html#plugins">plugins</a>. Modify
Markdown's behavior with <a
href="user-guide/configuration.html#markdown_extensions">Markdown
extensions</a>. Many <a
href="user-guide/configuration.html">configuration options</a> are
available.
</p>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-sm-6">
<div class="card">
<div class="card-body">
<h3 class="card-title">Preview your site as you work</h3>
<p class="card-text">
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.
</p>
</div>
</div>
</div>
<div class="col-sm-6">
<div class="card">
<div class="card-body">
<h3 class="card-title">Host anywhere</h3>
<p class="card-text">
MkDocs builds completely static HTML sites that you can host on
GitHub Pages, Amazon S3, or <a
href="user-guide/deploying-your-docs.html">anywhere</a> else you
choose.
</p>
</div>
</div>
</div>
</div>
</div>
|
