https://github.com/arkantrust/mermeditor
A live editor for mermaid with built-in integration for github, gitlab and gitea.
https://github.com/arkantrust/mermeditor
mermaid serverless web
Last synced: 4 months ago
JSON representation
A live editor for mermaid with built-in integration for github, gitlab and gitea.
- Host: GitHub
- URL: https://github.com/arkantrust/mermeditor
- Owner: arkantrust
- License: mit
- Created: 2024-07-15T04:34:00.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T03:02:03.000Z (almost 2 years ago)
- Last Synced: 2025-05-31T14:10:11.785Z (about 1 year ago)
- Topics: mermaid, serverless, web
- Homepage:
- Size: 1.95 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mermeditor
A real-time web editor for creating and editing Mermaid diagrams, with GitHub integration for saving and committing diagrams.
## Features
- Real-time Mermaid diagram rendering
- GitHub OAuth authentication
- Save and commit diagrams to GitHub repositories
## Setup
### Backend
1. Deploy the Go OAuth backend to Google Cloud Functions.
2. Set the environment variables `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET`.
### Frontend
1. Host the static files (index.html, styles.css, script.js) on GitHub Pages.
## Usage
1. Open the editor at [https://yourusername.github.io/mermaid-editor](https://yourusername.github.io/mermaid-editor).
2. Log in with GitHub and start editing your diagrams.
3. Save and commit diagrams to your GitHub repository.
## Coming soon
GitLab and Gitea integrations. https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.