Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the possibility to namespace markdown docs #855

Closed
steevehook opened this issue Jul 16, 2018 · 2 comments
Closed

Document the possibility to namespace markdown docs #855

steevehook opened this issue Jul 16, 2018 · 2 comments
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.

Comments

@steevehook
Copy link
Contributor

steevehook commented Jul 16, 2018

🚀 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 🗡

@endiliey endiliey added help wanted Asking for outside help and/or contributions to this particular issue or PR. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. documentation The issue is related to the documentation of Docusaurus labels Jul 16, 2018
@endiliey
Copy link
Contributor

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 ? 😉

@steevehook
Copy link
Contributor Author

Sure, my pleasure to contribute man 😉

@endiliey endiliey added status: claimed Issue has been claimed by a contributor who plans to work on it. PR pending labels Jul 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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.
Projects
None yet
Development

No branches or pull requests

2 participants