Repository navigation
docs: render the README sequence diagram as SVG for npm - #22
Merged
Merged
Conversation
npm doesn't render Mermaid code blocks, so the package page showed the diagram source. Replace the block with light and dark SVG files rendered by mermaid-cli, and keep the Mermaid source in assets/ to regenerate them.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
npm doesn't render Mermaid code blocks, so the package page on npm showed the diagram source in "How Iterward works" instead of the diagram.
This PR makes the following changes:
packages/iterward/README.mdwith a<picture>element, the same pattern the logo uses.foreignObject, so they display as images.assets/how-iterward-works.mmdfor regeneration.The image URLs point to
mainon raw.githubusercontent.com, so the diagram appears on npm after this PR merges and the next release publishes.