Add mermaid.js as a dependency #5019
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
pezholio
force-pushed
the
add-mermaid-js-dependency
branch
4 times, most recently
from
34251ad to
703d69f
Compare
This loops through all the direct dependencies specified in package.json and adds the `dist` directory to the sprockets path, to ensure the dependency’s code gets loaded.
This initializes mermaid.js with a custom selector, which ensures we support Mermaid charts that have been loaded in from Github.
pezholio
force-pushed
the
add-mermaid-js-dependency
branch
from
703d69f to
12c8edf
Compare
pezholio
added a commit
to alphagov/govuk-docker
that referenced
this pull request
Mar 12, 2025
We’ve now added JS dependencies (see alphagov/govuk-developer-docs#5019) so we should add `yarn` as a step when making and spinning up the project.
pezholio
added a commit
to alphagov/govuk-docker
that referenced
this pull request
Mar 12, 2025
We’ve now added JS dependencies (see alphagov/govuk-developer-docs#5019) so we should add `yarn` as a step when making and spinning up the project.
pezholio
added a commit
to alphagov/govuk-docker
that referenced
this pull request
Mar 12, 2025
We’ve now added JS dependencies (see alphagov/govuk-developer-docs#5019) so we should add `yarn` as a step when making and spinning up the project.
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.
https://trello.com/c/JfbTFW0e/917-tech-documentation
A lot of docs are loaded in from Github. As Github-flavoured Markdown supports Mermaid for diagrams, Mermaid markup is used in a lot of our Readmes and docs (For example). This renders great in Github, but when we load it into developer docs, we just see the source code, for example:
This loads in Mermaid.js as a dependency, so now docs render like so:
This is the first time we've introduced JS-level dependencies to this repo, so I'd appreciate a steer that I've done it correctly!