mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-30 18:24:35 +01:00
Documentation (#6438)
This commit is contained in:
parent
0b38323a31
commit
d363f903b8
@ -181,6 +181,36 @@ For further information, see the [documentation].
|
|||||||
[theme extension]: ../customization.md
|
[theme extension]: ../customization.md
|
||||||
[documentation]: https://guts.github.io/mkdocs-rss-plugin/configuration/
|
[documentation]: https://guts.github.io/mkdocs-rss-plugin/configuration/
|
||||||
|
|
||||||
|
### Blog only
|
||||||
|
|
||||||
|
You might need to build a pure blog without any documentation.
|
||||||
|
In this case, you can create a folder tree like this:
|
||||||
|
|
||||||
|
``` { .sh .no-copy }
|
||||||
|
.
|
||||||
|
├─ docs/
|
||||||
|
│ ├─ posts/ # (1)!
|
||||||
|
│ ├─ .authors.yml
|
||||||
|
│ └─ index.md
|
||||||
|
└─ mkdocs.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Notice that the `posts` directory is in the root of `docs` without
|
||||||
|
intermediate `blog` directory.
|
||||||
|
|
||||||
|
And add the following lines to `mkdocs.yml`:
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
plugins:
|
||||||
|
- blog:
|
||||||
|
blog_dir: . # (1)!
|
||||||
|
```
|
||||||
|
|
||||||
|
1. More info about [blog_dir](../plugins/blog.md#config.blog_dir)
|
||||||
|
|
||||||
|
With this configuration, the url of the blog post will be `/<post_slug>`
|
||||||
|
instead of `/blog/<post_slug>`.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Writing your first post
|
### Writing your first post
|
||||||
|
Loading…
Reference in New Issue
Block a user