Skip to content

closetgeekshow/axure-to-mermaid

Repository files navigation

Axure to Mermaid Bookmarklet

This bookmarklet script allows you to convert Axure RP prototype page trees into Mermaid flowcharts directly in your browser. It generates a toolbar that lets you export the sitemap as Mermaid markup, which can be copied, downloaded as TXT, SVG, or PNG, or shared via URL.

Installation

  1. Copy the contents of dist/axure-to-mermaid.bookmarklet.js
  2. Add a bookmark on the bookmark toolbar in Chrome, Firefox or Edge
  3. Paste it as the URL. Double Check that the URL begins with javascript:

Usage

  1. Navigate to an Axure prototype.
  2. Click the bookmarklet in your bookmarks toolbar.
  3. A toolbar will appear at the bottom right of the page.
  4. Use the toolbar to generate and export Mermaid diagrams.

Features

  • Convert the entire sitemap or start from the current page.
  • Copy Mermaid markup to the clipboard.
  • Download Mermaid diagrams as TXT, SVG, or PNG. !
  • Share diagrams via URL. !

Notes

  • Ensure that the Axure prototype is fully loaded before running the bookmarklet.
  • The bookmarklet relies on the Axure global object ($axure), so it only works inside the Axure prototype player.
  • I think it works as a Cloud plugin too

Warning

Features that use Mermaid.Ink will send your chart content to a third-party server. If you want to keep things entirely private only use the Copy or TXT buttons and generate the chart yourself using Mermaid.Live, Mermaid CLI or the Mermaid JS library.

"Dependencies"

All dependency scripts are injected from CDN sources to keep bookmarklet at a reasonable size.

Prior art/inspiration

  • @samuei's subgraph technique
    • I've added styles to make the subgraphs have no visual component beyond structure
  • Mermaid.Ink service allows for the generation of mermaid chart images and PDFs with just a URL

Future Ideas

  • Make it work with the Mermaid JS library instead of Mermaid.Ink. I have mermaid chart generation working in a privste plugin for myself, but I wanted to try to make it work with Mermaid.Ink this time.
  • Label the Mermaid.Ink buttons better or include a warning modal the first time you click one
  • styling based on name, hierarchy position, etc.
  • annotate the source URL on diagram
  • Start From Parent Folder generation method
  • configuration options (white background, mermaid config settings, copy on generate)
  • responsive toolbar
  • Convert Axure Flowcharts to mermaid (this actually looks pretty easy or at least not super hard)

Contact

Bluesky: @closetgeekshow.ca | Mastodon: @closetgeekshow@c.im | Email: closetgeekshow@gmail.com

Project Link: https://github.com/closetgeekshow/axure-to-mermaid

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published