mirror of
https://github.com/thangisme/notes.git
synced 2025-02-21 06:57:46 -05:00
Move this down
This commit is contained in:
parent
f76b891038
commit
68d5c56cf3
@ -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.
|
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
|
## Site logo
|
||||||
|
|
||||||
@ -190,3 +143,52 @@ See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more
|
|||||||
ga_tracking: UA-5555555-55
|
ga_tracking: UA-5555555-55
|
||||||
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default)
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user