From b32c00a70163912c7ab2ee163dcf5641b7874dba Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Fri, 10 Jul 2020 20:36:05 +0200
Subject: [PATCH] Improved documentation of just-the-docs.collections
nav_exclude and search_exclude
---
docs/configuration.md | 35 +++++++++++++++++++++--------------
1 file changed, 21 insertions(+), 14 deletions(-)
diff --git a/docs/configuration.md b/docs/configuration.md
index ee877529..c71a3a9c 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -25,10 +25,9 @@ View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/
## Document collections
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/).
-Collections group documents that semantically belong together.
+Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/) which group documents semantically 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
# Define Jekyll collections
collections:
@@ -37,12 +36,19 @@ collections:
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
+just_the_docs:
+ # Define which collections are used in just-the-docs
+ collections:
+ # Reference the "docs" collection
+ docs:
+ # 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.
@@ -56,11 +62,12 @@ collections:
permalink: "/:collection/:path/"
output: true
-doc_collections:
- docs:
- name: Documentation
- tutorials:
- name: Tutorials
+just_the_docs:
+ collections:
+ docs:
+ name: Documentation
+ tutorials:
+ name: Tutorials
```
## Site logo
--
GitLab