Improved documentation of just-the-docs.collections nav_exclude and search_exclude

This commit is contained in:
Silvio Giebl 2020-07-10 20:36:05 +02:00
parent 6b27beaf58
commit b32c00a701
1 changed files with 21 additions and 14 deletions

View File

@ -25,10 +25,9 @@ View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/
## Document collections ## Document collections
By default, the navigation and search include normal [pages](https://jekyllrb.com/docs/pages/). By default, the navigation and search include normal [pages](https://jekyllrb.com/docs/pages/).
Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/). Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/) which group documents semantically together.
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: For example, put all your documentation files in the `_docs` folder and create the `docs` collection:
```yaml ```yaml
# Define Jekyll collections # Define Jekyll collections
collections: collections:
@ -37,12 +36,19 @@ collections:
permalink: "/:collection/:path/" permalink: "/:collection/:path/"
output: true output: true
# Define which collections are used in just-the-docs just_the_docs:
doc_collections: # Define which collections are used in just-the-docs
# Reference the "docs" collection collections:
docs: # Reference the "docs" collection
# Give the collection a name docs:
name: Documentation # Give the collection a name
name: Documentation
# Exclude the collection from the navigation
# Supports true or false (default)
nav_exclude: false;
# Exclude the collection from the search
# Supports true or false (default)
search_exclude: false;
``` ```
You can reference multiple collections. You can reference multiple collections.
@ -56,11 +62,12 @@ collections:
permalink: "/:collection/:path/" permalink: "/:collection/:path/"
output: true output: true
doc_collections: just_the_docs:
docs: collections:
name: Documentation docs:
tutorials: name: Documentation
name: Tutorials tutorials:
name: Tutorials
``` ```
## Site logo ## Site logo