Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Open WIN Community
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
open-science
community
Open WIN Community
Commits
b32c00a7
Commit
b32c00a7
authored
4 years ago
by
Silvio Giebl
Browse files
Options
Downloads
Patches
Plain Diff
Improved documentation of just-the-docs.collections nav_exclude and search_exclude
parent
6b27beaf
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/configuration.md
+21
-14
21 additions, 14 deletions
docs/configuration.md
with
21 additions
and
14 deletions
docs/configuration.md
+
21
−
14
View file @
b32c00a7
...
@@ -25,10 +25,9 @@ View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/
...
@@ -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:
...
@@ -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:
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment