steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-10 14:01:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs(collections): Add warning about mandatory _-prefix (#1091)

Browse Source 
* docs(collections): Add warning about mandatory `_`-prefix

* Apply recommended wording
This commit is contained in:
Flo 2022-12-27 17:56:44 +01:00 committed by GitHub
parent c1c44e88cf
commit 0b44f5ba7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/configuration.md
View File

@ -233,6 +233,9 @@ ga_tracking: "UA-1234567-89,G-1AB234CDE5"
By default, the navigation and search include normal [pages](https://jekyllrb.com/docs/pages/).
You can also use [Jekyll collections](https://jekyllrb.com/docs/collections/) which group documents semantically together.
{: .warning }
> Collection folders always start with an underscore (`_`), e.g. `_tests`. You won't see your collections if you omit the prefix.
For example, put all your test files in the `_tests` folder and create the `tests` collection:
```yaml