You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://squidfunk.github.io/mkdocs-material/)
10
+
11
+
12
+
# Authors Guide
13
+
14
+
Requirements:
15
+
-**Python** (any recent should be fine. Recommended to use a virtual environtment.)
16
+
-**Material for MkDocs**
17
+
18
+
`pip install mkdocs-material`
19
+
20
+
[Material for MKDocs](https://squidfunk.github.io/mkdocs-material/) is a theme and plugin package for [MkDocs](https://www.mkdocs.org). Visit both sites for complete information.
21
+
22
+
23
+
## Commands
24
+
25
+
*`mkdocs serve` - Start the live-reloading docs server. Use this to test changes locally before pushing.
26
+
*`mkdocs -h` - Print help message and exit.
27
+
28
+
## Project layout
29
+
30
+
mkdocs.yml # The configuration file.
31
+
docs/
32
+
index.md # The documentation homepage.
33
+
posts/ # blog posts, organised anyway you like
34
+
... # Other markdown pages, images and other files.
0 commit comments