https://github.com/Moeditor/Moeditor

(discontinued) Your all-purpose markdown editor.
https://github.com/Moeditor/Moeditor

electron markdown markdown-editor

Last synced: 12 days ago
JSON representation

(discontinued) Your all-purpose markdown editor.

• Host: GitHub
• URL: https://github.com/Moeditor/Moeditor
• Owner: Moeditor
• License: gpl-3.0
• Archived: true
• Created: 2016-06-24T01:11:26.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-07-07T01:08:32.000Z (over 4 years ago)
• Last Synced: 2024-09-30T00:44:20.340Z (about 1 month ago)
• Topics: electron, markdown, markdown-editor
• Language: JavaScript
• Homepage: https://moeditor.github.io
• Size: 2.72 MB
• Stars: 4,122
• Watchers: 101
• Forks: 277
• Open Issues: 114
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - Moeditor/Moeditor - (discontinued) Your all-purpose markdown editor. (markdown)

README

        
# Moeditor

Your all-purpose markdown editor.

Built with Electron.

**Discuss on Telegram: https://t.me/Moeditor and help me work on the new version!**

Visit our [homepage](https://moeditor.github.io/) or download [releases](https://github.com/Moeditor/Moeditor/releases).

# Features

* GitHub Flavored Markdown

* TeX math expressions

* UML diagrams

* Code highlight in editor

* Read/Write/Preview mode

* Custom font / line height / font size

* Code highlight themes (powered by [highlight.js](https://highlightjs.org/))

* Auto reload

* Localization

* Focus mode

# Screenshots

![Moeditor Main](screenshots/main.png)

![Moeditor Side Menu](screenshots/side-menu.png)

![Moeditor About](screenshots/about.png)

![Moeditor Write Mode](screenshots/write-mode.png)

# Building

```bash

npm install

npm start

```

In China, you may want to replace npm with cnpm for a faster download speed.

```bash

npm install cnpm -g --registry=https://registry.npm.taobao.org

cnpm install

cnpm start

```

# Debugging

There's three ways to open the [Chromium Developer Tools](https://developer.chrome.com/devtools).

* Add `--debug` to the command line args:

```bash

npm start -- --debug

```

* Set `debug` to `true` in the config. The config file is stored in `~/.config/configstore/Moeditor.json` (for every system).

* `Ctrl` + `Shift` + `I` in Linux / Windows or `Command` + `Option` + `I` in OS X / macOS to toggle devtools for a window.

# Todo

* [ ] Custom themes

* [ ] Spell check

* [ ] UI/UX

# Localization

Moeditor will auto detect your system language and use the localization.

You can set language manually in the Settings window.

Now the app supports English, Chinese, French, German, Spanish and *incomplete* Portuguese.

**Help us** if you can translate this app. Please follow the guide in `app/moe-l10n.js`.

# License

Moeditor itself is licensed under the **GPL v3** license.

Some node modules are licensed under other free software license.

The `Raleway` font is licensed under the OFL open font license.

# Credits

The domain `moeditor.org` is sponsored by [Showfom](https://ttt.tt/).

# Known Bug(s)

Issue #31.