Support composable docs.json file
#3166
Blargian
started this conversation in
Feature Requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
What is the current behavior?
At the moment everything needs to be defined inside a single
docs.jsonfile. Take for example thedocs.jsonfile for the Mintlify docs: https://github.com/mintlify/docs/blob/main/docs.json which has multiple languages and redirects.How could it improve?
It would be cool if there was a way to pull-in definitions stored in other json files. For example if you could have separate
docs-ja.json,docs-ko.json,docs-ru.jsonfiles for languages or aredirects.jsonfor redirects. You could then just specify the relative path to those files indocs.json, for example something like:Why is this worth implementing?
Having the ability to split up
docs.jsonallows for easier parsing of the file as a human and it separates concerns.Additionally, Docusaurus supports this in
docusaurus.config.js.Fern also partially supports this, at least with regards to navigation. It's possible on their platform to have multiple .yml files defining the navigation and to import them into the parent "docs.json" equivalent.
In both cases it is a substantial quality of life improvement imo.
Beta Was this translation helpful? Give feedback.
All reactions