Document the possibility to namespace markdown docs #855
Labels
documentation
The issue is related to the documentation of Docusaurus
good first issue
If you are just getting started with Docusaurus, this issue should be a good place to begin.
help wanted
Asking for outside help and/or contributions to this particular issue or PR.
status: claimed
Issue has been claimed by a contributor who plans to work on it.
🚀 Feature
Currently the approach is to stuff every doc inside docs folder and if the docs grows on an on, it's a bit hard to find the needed doc. What I've seen works but it's nowhere documented is to omit the id from markdown document and have them placed inside directories. Then later reference them as
/dir/doc
Document the possibility of structuring the docs across directories aka name spacing them. Currently if placing a document inside a folder then referencing it by id will break. However if placing it inside a directory and omitting the id it can be referenced such as
directory/document-name
Motivation
It is important to outline this because otherwise stuffing markdown documents inside root docs becomes a mess real quick for large documentations
Pitch
This is not really a feature, yet an enhancement of better structuring. As far as I've seen it's already implemented it's just not documented yet.
Thanks for this awesome tool guys and sorry for throwing proposals at you 🗡
The text was updated successfully, but these errors were encountered: