Support Mermaid.js for diagrams #6327
Merged
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
knative-prow
bot
added
the
approved
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
knative-prow
bot
added
the
size/S
evankanderson
force-pushed
the
diagram-assist
branch
2 times, most recently
from
a75a1df to
c52851f
Compare
evankanderson
force-pushed
the
diagram-assist
branch
from
c52851f to
da569e9
Compare
|
The titles overlap a bit with the arrows - unsure if you can tweak that. Ideally you could put the text on top of the arrow with some border. 
|
|
The Mermaid.js documentation does the same thing, so I think that's something we may have to live with or get fixed upstream |
|
Probably the "correct" solution would be to include the text box in the arrow target, rather than just the icon. |
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dprotaso, evankanderson The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
evankanderson
added a commit
to evankanderson/docs
that referenced
this pull request
Sep 25, 2025
knative-prow bot
pushed a commit
that referenced
this pull request
Sep 25, 2025
* Phase 1: Adding documentation metadata tags (#6274) * Add metadata tags for documentation * Add classification for about 2/3rds of docs (func + eventing) * Add classification for remainder of docs (serving+install) * Add mermaid support (#6327) * Publish threat model in documentation (#6263) * Publish threat model in documentation * Separate security contents a bit more, update link to threat model, update nav * Add a section on supply chain and SBOM/SLSA mitigation * Update threat model with feedback from David Hadas * Update introduction with content from davidhadas, add sections on controller and webhook functionality and update targets of threats * content tab fixes, added success output for kn func (#6367) * Add dry run section and take out old feature flag in serving (#6366) * add dry run section * drop mention of old feature flag * fix casing on nav * update docs to be more clear and include inline example --------- Co-authored-by: Dave Protasowski <dprotaso@gmail.com> * Attempt to rebuild docs build process, inspired by #6319 (#6371) * Attempt to rebuild docs build process * Use a more modern python version * Fix strict verify, hide versions on unversioned pages * Fix search with mkdocs typescript patches (vendored). (#6392) Hopefully, this can be fixed upstream via PR shortly. * Installation Doc Updates (#6395) * Installation Doc Updates Improve installation guidance * Formatting fix * Update docs/install/README.md link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Update docs/install/README.md link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * link fix and table update More writing * Update README.md Misc edits * Update README.md Minor edits * Adding install-kn to PR Consolidating CLI installations into this this topic. * Update install-kn.md Changing red bug alert to important The old syntax was: ??? bug "Having issues upgrading `kn` to Homebrew?" * Update install-kn (snippet) Removed alert formatting * Added quickstart-install.md Various edits * Fixes and reviewed edits Made Evan suggestions, table column test, spelling fixes * Update quickstart-install.md link fix * Update README.md Replaced the table with a bulleted list approach. * Update README.md Put back the table * Added serving and eventing install topics Updated topics per effort - consolidating guidance * Link fixes * Made Evan's edits * Various updates All files added for this PR. * Link fix * Formatting fixes * Formatting and consistency fix * Update docs/install/operator/knative-with-operator-cli.md Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Update docs/client/install-kn.md Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> --------- Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Fix edit page links, move technical docs under sub-heading (#6398) * Fix edit links by moving docs content under a dedicated subdirectory * Fix edit links by moving docs content under a dedicated subdirectory * Add High availability documentation section for eventing (#6401) I have copy-pasted from the Knative Serving documentation page the block as I found it missing when configuring it. * Update proc-running-function.md (#6400) Undo separeate kn func output for invoke * Add a note that Apache Kafka is required to use EKB (#6404) * Move install docs to administration (#6403) * Fix trailing newline complaints * Fix redirects from #6398 --------- Co-authored-by: Bruce Hamilton <scarlettbernique@gmail.com> Co-authored-by: Alexander-Kita <Alexander.Kita@ibm.com> Co-authored-by: Dave Protasowski <dprotaso@gmail.com> Co-authored-by: Aurélien Joga <aurelienjoga+ajoga@gmail.com> Co-authored-by: Christoph Stäbler <cstabler@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Supports #6310
Currently, we have a wide variety of different graphic styles on our website. I'm going to suggest narrowing our art sources to using either SVGs from a real drawing program, or generating them from Mermaid.js markup, which is supported (and recommended) by the Material MkDocs tool we use for the site
Proposed Changes
Once we have an icon library, we should look at customizing mermaid to use a custom icon pack with our icons.