docs: link to mermaid config types #8830
Conversation
|
Hi @PaulRBerg! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
| @@ -82,4 +82,4 @@ module.exports = { | |||
| }; | |||
| ``` | |||
|
|
|||
| See the [Mermaid configuration documentation](https://mermaid-js.github.io/mermaid/#/./Setup?id=configuration) for the available config options. | |||
| See the [Mermaid config documentation](https://mermaid-js.github.io/mermaid/#/./Setup?id=configuration) and the [Mermaid config types](https://github.com/mermaid-js/mermaid/blob/v9.4.3/packages/mermaid/src/config.type.ts) for the available config options. | |||
There was a problem hiding this comment.
Linking to a specific version is very hard to update in the future. Maybe just link to main?
There was a problem hiding this comment.
Works for me! They are using master though, not main.
Pushed a new commit to do this
slorber
added
the
pr: documentation
|
Thanks 👍 |
Pre-flight checklist
Motivation
As discussed in #8806, the current link to the Mermaid docs website offers incomplete information.
This PR adds a link to the Mermaid config types, which makes it super clear what configuration options are available in Mermaid.