Docusaurus: Document the possibility to namespace markdown docs

Created on 16 Jul 2018  路  2Comments  路  Source: facebook/docusaurus

馃殌 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 馃棥

documentation good first issue help wanted claimed

Most helpful comment

Sure, my pleasure to contribute man 馃槈

All 2 comments

Thank you for this.

Currently if placing a document inside a folder then referencing it by id will break

Just wanted to point out that this is not true, if an id exist, it can be referenced as directory/id, it just seems that it is not documented so clearly.

Example: docs/make/adding-levels.md

---
id: adding-levels
title: Adding Levels
---

A level is another JavaScript object:

Then it should be referenced as
"make/adding-levels",

Reference of use case:

  1. https://github.com/olistic/warriorjs/tree/master/docs
  2. https://github.com/olistic/warriorjs/blob/master/website/sidebars.json

Will be great if anyone wanted to create a PR to document this clearly.
@steevehook want to create a PR for this ? 馃槈

Sure, my pleasure to contribute man 馃槈

Was this page helpful?
0 / 5 - 0 ratings