Auto-generate routes for components #7
Conversation
| @@ -8,7 +8,7 @@ export const useDynamicImport = (name: string): Props => { | |||
| let resolved = false; | |||
|
|
|||
| import(`@docgen/${name}.json`) | |||
| .then(props => { | |||
| .then(({ props }) => { | |||
There was a problem hiding this comment.
I thought it was easier to update the component's createData with the whole metadata, not only the props.
| ): Plugin<ComponentDoc[]> { | ||
| const { generatedFilesDir } = context; | ||
|
|
||
| const pluginId = id ?? DEFAULT_PLUGIN_ID; |
There was a problem hiding this comment.
Inspired by docusaurus-plugin-openapi setup.
| content.map(async component => { | ||
| const componentData = await createData( | ||
| `${component.displayName}.json`, | ||
| JSON.stringify(component) |
There was a problem hiding this comment.
This was the only breaking change: component instead of component.props
fsmaia
changed the title
|
Some screenshots of a local execution: React component docs: |
|
@atomicpages, could you help me on how to proceed with |
|
Hello there! I saw this MR and it's exactly what I need to document an SDK that my team is working on. Are there any plans on merging this one? |
|
cc @atomicpages |
|
👋 howdy, I'll dig into this more later in the week |
|
I think this PR deserve a merge 👍 |
|
Usually not keen to throw a "+1" on here but would like to bump this since it'd be super helpful for a project we're on. If timing doesn't make sense for you, @atomicpages, I can certainly fork and use my own branch. Appreciate the work here making my life a bit easier! |
Fixes #5.
I set an
addRouteto create a route for each component, plus an index route.These routes are wrapped by some layout components:
The user can enable this behavior with a
createRoutesflag, and also set abaseRouteroute, in which the routes/links will be created.