You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I could not find any out-of-the-box solution for this issue. The closest one is ReadTheDocs:
+ support versions
+ renders .md files
- no live code out of the box (I could not find any examples, likely doable with a Sphinx plugin)
- no RTL support, see readthedocs/readthedocs.org#2463
- based on Python, we might need to write plugins in Python
~ Accessibility needs testing
+ sphinx-js can partially autogenerate documentation
Another contender is Docusaurus V2
+ Written in React, is really easy to use React components
+ maintained by Facebook
+ supports versions
- could not find a way to autogenerate docs from code, we might need to write a plugin for this.
~ V2 is in alpha (but is already used in lots of places in production)
Context
Docs client
Summary
We need to pick a tool capable of handling versioning and all currently implemented features of the docs.
Justification
We'd like to support multiple versions of the project in the docs app.
Additional Details
Check out readthedocs.io , nextjs-MDX, Storybook, (most likely we want to use markdown)
The text was updated successfully, but these errors were encountered: