Mini Docs Generator #752
Open
Mini Docs Generator #752
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I did not take this to the conclusion of adding imports to individual layerchart components. I expect you'll want to tweak it before that step. This script generates mini-docs component files for all components in the layerchart library. * It extracts API properties from the generated/api/*.json files. * It extracts metadata from the docs/src/content/*.md files. * It extracts 1st usage example from the docs/src/examples/components/*.svelte files. * It trims the code to remove module exports and data export statement. * It applies the appropriate indentation to the code to preserve the indentation of the code in mini-docs. * It generates the mini-docs content and saves it as a svelte file in docs/src/generated/mini-docs/*.svelte. * Once the components are imported to the Layerchart components, you can hover over the component * in the IDE to see mini docs for each component. @description * Scans all .md files in docs/src/content and extracts: * - Component name * - Component URL * - Description * - Category * - Layers * - Related * - Usage example - @output Generates individual ts files in generated/mini-docs/ for each component
|
commit: |
Contributor
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I did not take this to the conclusion of adding imports to individual layerchart components. I expect you'll want to tweak it before that step.
This script generates mini-docs component files for all components in the layerchart library.
@description