Skip to content

Commit

Permalink
Release 0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
pedsm committed Jan 2, 2020
1 parent 96dabe4 commit ae82737
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 3 deletions.
Binary file added .github/iemanja1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# iemanja
A desktop mermaid editor
# Iemanja

[Iemanja](https://en.wikipedia.org/wiki/Yem%E1%BB%8Dja) (pronounced "e-a-manja") is an electron based desktop client for the [Mermaid](https://github.com/mermaid-js/mermaid) markup language.

![Iemanja Running on MAC](.github/iemanja1.png)

## Mermaid

Mermaid is a markup language that allows for the creation of diagrams and charts with a syntax inspired by Markdown. For more information on mermaid please visit their [Github page](https://github.com/mermaid-js) or their [docs](https://mermaid-js.github.io/mermaid/#/).

## Features

Iemanja is still in development but as of now these are some of the features that it has:

1. Exporting diagrams as `.svg`.
2. Creating, saving and loading `.mmd` files.
3. Live rendering of graphs/diagrams
4. Mermaid editing (through [monaco-editor](https://github.com/microsoft/monaco-editor))
5. Mermaid parser errors (Work in progress)
6. Mermaid syntax highlighting (Work in progress)

## Use case

Iemanja aims to provide a more fully fledged editing, theming and exporting experience locally. However, if you want to give Meramid a quick try feel free to use the official mermaid online [live editor](https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0hhcmRdIC0tPnxUZXh0fCBCKFJvdW5kKVxuICAgIEIgLS0-IEN7RGVjaXNpb259XG4gICAgQyAtLT58T25lfCBEW1Jlc3VsdCAxXVxuICAgIEMgLS0-fFR3b3wgRVtSZXN1bHQgMl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ) with many of the same features as Iemanja.

## Download

If you would like to try Iemanja for yourself you can download the latest release from the release page in this repo.

[Releases](https://github.com/pedsm/iemanja/releases)

> Currently only MacOs. Windows and Linux releases coming soon
2 changes: 1 addition & 1 deletion src/renderer/browser.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ async function main() {
const monaco = await loader()
injectMermaid(monaco)
editor = monaco.editor.create(document.getElementById('editor'), {
theme: 'vs-dark',
theme: 'vs',
value: state.get('content'),
automaticLayout: true,
language: 'mermaid',
Expand Down

0 comments on commit ae82737

Please sign in to comment.