Added documentation for doc_collections

pull/1/head
Silvio Giebl 2020-07-09 23:43:33 +02:00
parent d1c3e08337
commit b4b74f7e1d
1 changed files with 41 additions and 0 deletions

View File

@ -22,6 +22,47 @@ Just the Docs has some specific configuration parameters that can be defined in
View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
## Document collections
By default, the navigation display normal [pages](https://jekyllrb.com/docs/pages/).
Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/).
Collections group documents that semantically belong together.
For example, to group all documentation, put all your files in the `_docs` folder and create the `docs` collection:
```yaml
# Define Jekyll collections
collections:
# Define a collection named "docs", its documents reside in the "_docs" directory
docs:
permalink: "/:collection/:path/"
output: true
# Define which collections are used in just-the-docs
doc_collections:
# Reference the "docs" collection
docs:
# Give the collection a name
name: Documentation
```
You can reference multiple collections.
This creates categories in the navigation with the configured names.
```yaml
collections:
docs:
permalink: "/:collection/:path/"
output: true
tutorials:
permalink: "/:collection/:path/"
output: true
doc_collections:
docs:
name: Documentation
tutorials:
name: Tutorials
```
## Site logo
```yaml