melashri/n-mermaid
1
0
Fork 0
mirror of https://github.com/MohamedElashri/n-mermaid.git synced 2026-06-21 18:10:10 -04:00
Code Issues Projects Releases Packages Wiki Activity
No description
6 commits 2 branches 0 tags 1.1 MiB
  • JavaScript 48.1%
  • CSS 26.4%
  • HTML 25.5%
Find a file
Exact
MohamedElashri fde09e48c6
 improve the UX/UI
2026-06-06 09:56:18 +02:00
assets improve the UX/UI 2026-06-06 09:56:18 +02:00
index.html improve the UX/UI 2026-06-06 09:56:18 +02:00
LICENCE.md initial commit 2025-02-12 13:20:24 -05:00
README.md improve the UX/UI 2026-06-06 09:56:18 +02:00

README.md

N-Mermaid

N-Mermaid is a static, browser-only Mermaid editor and viewer. It renders diagrams locally, stores your draft in the browser, and exports diagrams without a backend or build step.

Features

  • Self-hosted Mermaid runtime pinned to 11.15.0
  • Live or manual rendering
  • Mermaid theme and look controls
  • Built-in examples for common diagram types
  • SVG and PNG export through browser APIs
  • PDF output through the browser print dialog
  • Source open, copy, and download actions
  • Completely client-side

Usage

A hosted version of the application is available at https://melashri.net/n-mermaid.

To use the application locally:

  1. Clone the repository: git clone https://github.com/MohamedElashri/n-mermaid.git
  2. Open index.html in your browser

No install step is required.

Hosting

The app is ready for GitHub Pages because it is plain HTML, CSS, and JavaScript. Serve the repository root as the Pages source.

Runtime

The only vendored JavaScript runtime is Mermaid:

  • assets/js/vendor/mermaid.min.js - Mermaid 11.15.0

The UI and export logic are implemented in:

  • assets/css/styles.css
  • assets/js/app.js

Contributing

If you find any bugs or have suggestions for improvement, please open an issue or a pull request on the GitHub repository.

License

This project is released under the MIT License.