Comments (2)
@kevinkleine I looked into this as I also wanted to include mermaid charts in the README and tutorials. Unfortunately it is not possible to implement in a jsdoc-plugin. It has no API to hook onto the README file or tutorials (jsdoc only passes doclets and whole js files to transform).
I got it to work anyways. I am using the fact, that the jsdoc markdown parser (marked) by default allows HTML to be added (even JavaScript). I created an script which detects GitLab-style mermaids and creates the graph with mermaid.
Use mermaid in jsdoc tutorials
It is quite hacky so I hope that jsdoc-plugins get more capabilities in the future (little hope though due to inactivity in the
jsdoc repository). Also my solution requires to add the script to each markdown including mermaid charts which is very annoying.
from jsdoc-mermaid.
Related Issues (5)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jsdoc-mermaid.