build(docs): use custom Vite plugin to develop docs #55
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 want to avoid syncing the README with the deployed demo site (e.g., #54).
Since the demo site is almost a verbatim reflection the README, it makes sense to build the docs site from the README.
This use a custom Vite plugin that preprocesses the README before it's processed by the Svelte Vite plugin.
It uses
marked
along with a couple of plugins to do the heavy lifting. In addition, it designated awatchDir
, in which component cases can be added or updated.These cases are then referenced as inline comments in the README. As Markdown, they are invisible, but in the docs site, they render the live example.
Some additional work following this: