Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Experimental docs app using Retype #2163

Open
geoffreymcgill opened this issue Jun 30, 2021 · 0 comments
Open

Experimental docs app using Retype #2163

geoffreymcgill opened this issue Jun 30, 2021 · 0 comments
Labels
Type: Other Not an enhancement or a bug

Comments

@geoffreymcgill
Copy link

Hi Mermaid team. Upon a community request, we recently added Mermaid support to Retype.

Since we're building a documentation generator... we thought it would be interesting to point it at the Mermaid /docs/ to see what happens.

One fork, a few adjustments to the configs, and 💥 ... an experimental set of 🧜‍♀️ Mermaid docs has been born. Self-hosted using GitHub Pages at,

https://geoffreymcgill.github.io/mermaid/

Screen Shot 2021-06-30 at 12 49 28 PM

Existing Mermaid docs for reference:
https://mermaid-js.github.io/mermaid/

Retype is relatively new and progressing rapidly. A new color palette (theme) feature is coming soon, so the Mermaid docs above could adopt a similar green theme to the links and other misc colors.

Anyways, I'll send the fork as a PR, do with it as you wish. Any feedback you have is greatly appreciated.

If you're interested in using Retype for your project, I would be more than happy to offer some suggestions on how to improve the docs content and structure to take full advantage of Retype.

Hope this helps.

@geoffreymcgill geoffreymcgill added the Type: Other Not an enhancement or a bug label Jun 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Other Not an enhancement or a bug
Projects
None yet
Development

No branches or pull requests

1 participant