File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # MkDocs
2+
3+ MkDocs is a smart, simple, website design tool.
4+
5+ ## Installation
6+
7+ Install the ` mkdocs ` command line tool...
8+
9+ ``` shell
10+ $ pip install mkdocs
11+ ```
12+
13+ ## Getting started
14+
15+ 1 . Create a ` README.md ` page.
16+ 2 . Run ` mkdocs serve ` to view your documentation in a browser.
17+ 3 . Run ` mkdocs build ` to build a static website ready to host.
18+
19+ MkDocs supports [ GitHub Flavored Markdown] ( writing.md ) for page authoring.
20+
21+ ## Adding pages
22+
23+ 1 . Create additional markdown pages.
24+ 2 . Use markdown interlinking between pages.
25+ 3 . Create a ` mkdocs.toml ` config file to define the site navigation.
26+
27+ ## Custom styling
28+
29+ 1 . Create a ` templates/base.html ` file to customise the layout.
30+ 2 . Create a ` css/base.css ` file to override the default styles.
31+ 3 . Create a ` js/base.css ` file to override the default scripts.
32+
33+ Simple [ styling adaptations] ( styling.md ) include customising the colour scheme, the typography, or choosing the code highlighting style.
You can’t perform that action at this time.
0 commit comments