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
68d5c56c
Unverified
Commit
68d5c56c
authored
4 years ago
by
Patrick Marsceill
Committed by
GitHub
4 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Move this down
parent
f76b8910
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
+49
-47
49 additions, 47 deletions
docs/configuration.md
with
49 additions
and
47 deletions
docs/configuration.md
+
49
−
47
View file @
68d5c56c
...
...
@@ -22,53 +22,6 @@ 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 and search include normal
[
pages
](
https://jekyllrb.com/docs/pages/
)
.
Instead, you can also use
[
Jekyll collections
](
https://jekyllrb.com/docs/collections/
)
which group documents semantically together.
For example, put all your documentation 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
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.
This creates categories in the navigation with the configured names.
```
yaml
collections
:
docs
:
permalink
:
"
/:collection/:path/"
output
:
true
tutorials
:
permalink
:
"
/:collection/:path/"
output
:
true
just_the_docs
:
collections
:
docs
:
name
:
Documentation
tutorials
:
name
:
Tutorials
```
## Site logo
...
...
@@ -190,3 +143,52 @@ See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more
ga_tracking
:
UA-5555555-55
ga_tracking_anonymize_ip
:
true
# Use GDPR compliant Google Analytics settings (true by default)
```
## 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/
)
which group documents semantically together.
For example, put all your documentation 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
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.
This creates categories in the navigation with the configured names.
```
yaml
collections
:
docs
:
permalink
:
"
/:collection/:path/"
output
:
true
tutorials
:
permalink
:
"
/:collection/:path/"
output
:
true
just_the_docs
:
collections
:
docs
:
name
:
Documentation
tutorials
:
name
:
Tutorials
```
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