GitToTheHub commented on PR #573: URL: https://github.com/apache/cordova/pull/573#issuecomment-3660573616
> I don't foresee the `cordova` repo readme ever becoming part of the docs site but if we wanted to keep a consistent style and have a diagram to describe a plugin architecture or whatever, then using mermaid might impose a problem. Plugins might be rather simple to call for a diagram, but I can see potential use case for platform documentation. If there is a jekyll plugin that renders mermaid diagrams, that might be a solution. > > Just if we are going to use a diagram software, we should attempt to not lock out the usage in the docs site which is rendered outside of github... that we can keep a consistent styling throughout Cordova pages. Ok, good you mention that. I had the thought, that NPM could also be a problem and looked for the [mermaid package on NPM](https://www.npmjs.com/package/mermaid) if the diagrams get rendered, but they aren't. Maybe as an alternative the image could be attached within a [`<details>` tag](https://gist.github.com/scmx/eca72d44afee0113ceb0349dd54a84a2). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
