moeditor/moeditor

(discontinued) Your all-purpose markdown editor.

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 or download 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)
• Auto reload
• Localization
• Focus mode

Screenshots

Building

npm install
npm start

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

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.

• Add --debug to the command line args:

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.

Known Bug(s)

Issue #31.

moeditor's Issues

Which one should I download ?

What should I download so that it works on OS X ?

Vim key bindings

As a vimer, I think vim key bindings may be a great feature. Add the editor seems to use codemirror, if so, vim.js may be helpful.

Add read mode

sometimes I just want to read a rendered markdown file, so can we have a read mode like zen mode?

TeX parse error

When trying to view this file -> https://github.com/medikoo/memoizee/blob/master/README.md

In Installation section I got:

TeX parse error: You can't use 'macro parameter character #' in math mode 

Screenshot:

Hebrew Translation & Support

I started working on a Hebrew translation. I already translated all the strings to Hebrew (see https://github.com/tmr232/Moeditor/tree/hebrew), but it is far from enough.

Since Hebrew is a RTL language, everything looks really bad in Hebrew. The text aligned to the wrong direction in both the Edit area and the menus.

I think it would be nice if we had RTL support (separate from language settings). This will benefit both my Hebrew translation, as well as future RTL translations (Arabic, I guess).

Don't use 7z

Please don't use 7z, macOS, Windows and Linux do not have native 7z support.

构建失败

D:\Users\fly\Documents\GitHub\Moeditor [master]> cnpm start

[email protected] start D:\Users\fly\Documents\GitHub\Moeditor
electron .

fs.js:549
return binding.open(pathModule._makeLong(path), stringToFlags(flags), mode);
^

Error: ENOENT: no such file or directory, open 'D:\Users\fly\Documents\GitHub\Moeditor\node_modules\electron-prebuilt\path.txt'
at Error (native)
at Object.fs.openSync (fs.js:549:18)
at Object.fs.readFileSync (fs.js:397:15)
at Object. (D:\Users\fly\Documents\GitHub\Moeditor\node_modules\electron-prebuilt\index.js:4:42)
at Module._compile (module.js:435:26)
at Object.Module._extensions..js (module.js:442:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:311:12)
at Module.require (module.js:366:17)
at require (module.js:385:17)

npm ERR! Windows_NT 10.0.10586
npm ERR! argv "D:\Program Files\nodejs\node.exe" "C:\Users\fly\AppData\Roaming\npm\node_modules\cnpm\node_modules\npm\bin\npm-cli.js" "--userconfig=C:\Users\fly.cnpmrc" "--disturl=https://npm.taobao.org/mirrors/node" "--registry=https://registry.npm.taobao.org" "start"
npm ERR! node v4.2.1
npm ERR! npm v3.10.5
npm ERR! code ELIFECYCLE
npm ERR! [email protected] start: electron .
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script 'electron .'.
npm ERR! Make sure you have the latest version of node.js and npm installed.
npm ERR! If you do, this is most likely a problem with the moeditor package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR! electron .
npm ERR! You can get information on how to open an issue for this project with:
npm ERR! npm bugs moeditor
npm ERR! Or if that isn't available, you can get their info via:
npm ERR! npm owner ls moeditor
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR! D:\Users\fly\Documents\GitHub\Moeditor\npm-debug.log

Align markdown to output on synchronized scrolling

Making the output align to the currently written text would be an awesome feature.

Other than that, love the editor. It is simple, but looks amazing.

support todotasks?

deb, rpm, and pacman files for better linux install

It would be handy to release deb and rpm and possibly even pacman files for better installations on linux. There is a super easy package maker which would make this task trivial. https://github.com/jordansissel/fpm

Use Travis CI to publish builds automatically

what about multi-editing in tabs?

really missed this

How to contribute

Hi,

I'd like to try to contribute by adding web publishing to ghost or wordpress. How should I proceed?

Thanks and congratulations for the great app!

Export As

Is it possible/planned to add an PDF/HTML export or the rendering ?
It will be really usefull ;)

Mode selection menu looks wrong

The line breaks make it look really odd.

Add brew cask install support

Thanks for the great work!
It's better to add brew cask install support. That way, we can install it by:

brew cask install moeditor

Add spell check

Configurable Tab Size

Can we make the tab size configurable?

No line break between diagrams

When sequence or flow diagrams follow each other in a document, no line breaks are added between them. This is hardly the behaviour I would expect.

I assume that it is because each diagram is stored inside a <span> element. The same behaviour also makes them inlined if not explicitly separated by a blank line.

I think using <p> instead will be a good solution.

Question about package.json

I was going through the package.json and i noticed this line. Is that semvar correct?

Preview doesn't stay inline with markdown

Here's a sample that I was using to test Moeditor for bugs when I found this issue.
It also doesn't inline code such as $1.alete.xyz

UI Themes

Hello,

Are you thinking about adding an option to change the theme / color scheme of the Markdown Editor?

For example a dark mode

Thanks 👍

Bug: Aboutscreen Link

On the Aboutscreen "Menci" seems to be a link, however it doesn't open anything.

Translation

What about this topic? I think it would be cool, I can build it but I just want to ask if there is interest in having something like this, even if there is not much text in the application. We could detect the OS language and set the program language with that. I could translate Moeditor to German and French.

how difficult to add another formt-syntax?

for example ReStructuredText? what needed for this? parser (to html?) on js and highlighter?

PR: Spectron support

Willing to make a PR that adds spectron support, which is very useful for e2e testing. Would this PR be welcome?

Need more accurate synchronized scrolling

The scrolling is now synchronized just by offset percentage. The mismatch will grow while more and more images are added to the mdl

Keybindings to switch between Read/Write modes

It would be nice if entering a key sequence like ctrl-r to switch it to read mode and something like ctrl-g to switch to write mode.

The only problem with this that I can think of is deciding what read/write mode to toggle between.

feature request: auto reload

Feature request:

When moeditor loses the focus and gets the focus again, it should check whether the contents of the current file has changed, and if so, reload the current file to the latest version.

Rendering Code section failed

This code break the rendering of the md file.
`
``` php
$skills = array();
$skills->append($resume->getSkills());
foreach($resume->getExperiences() as $xp)
$skills->append($xp->getSkills());
foreach($resume->getEducations() as $ed)
$skills->append($ed->getSkills());
foreach($resume->getProjects() as $pr)
$skills->append($pr->getSkills());

`

Website Defekt Ubuntu Download

This may just be a silly Bug, however I just try to install the editor over on https://moeditor.github.io/ and since I am on Ubuntu i clicked on the ubuntu Button. But instead of downloading any file i just got a github error message. (All other downloads starts just normal)

Open file in command line

This is a feature request, it would be awesome if we can make this happen, like:

$ moe readme.md

Add Win x64 build

Add Win x64 build.

Something wrong in OSX package.

I used electron-packager to export osx package,but when I run i found the "Edit" menu inside were gone.
At the same icon is also a problem.
The following are my modifications to the file package.json

"scripts": { "start": "electron .", "package": "electron-packager ~/Desktop/Moeditor-master Moeditor --platform=mas --arch=x64 --out ~/Desktop/MoeTest --version 1.0.0 --overwrite --icon=./icons/Moeditor.svg" },

Focus issues with Zen mode

In Zen mode, if I click outside the editor area (but still in the app) the editor looses the focus and I can no longer type.
I think the text should keep the focus regardless of the click location.

syntax-highlighting in 'source' block

also u can see incorrect scroll-sync in this screenshot

Feature request: GitHub sync

Most users will use Moeditor for GitHub so it would be nice (but definitely not necessary) to see which lines are already on GitHub and which ones I had changed (like Atom).
Maybe you can also implement the whole 'upload to git server' process.

However this is definitely not necessary and it sounds like a lot of work.

Feature request: Floating Infos

I would like to see Floting Informations over the icon in the bottom panel when the mouse is above them.
I know that is not a life-changing feature but it can be a little bit of help since it took me almost 5 minutes to figure out what the double circle icon does.

The screenshot is how I imagine this feature.

Question: Opening devtools?

What is the instructed development guide for this project? I'm trying to debug the project bug I cant open devtools because they're not included. What is the recommended method of debugging?

Feature request: Shortcut indicator

Key shortcuts like "ctrl + S" work just fine however it might be a better UX if ther would be a indicator so i get a visual feedback that the file is save correctly or something like that.

Add zen-mode

The editor looks amazing. It would be great if I could have the raw-markdown part in the middle of the screen, with nothing beside it. No preview.

export to pdf support!

Thanks

Dollar sign escaping and # inside code blocks.

The dollar sign isn't being escaped when writing $.
Also, writing # inside a code block (indented with 4 spaces) formats the text as a title on the left side, whereas it should be just a comment.

EDIT: The latter doesn't happen with code blocks made of backticks, although it shouldn't happen at all.

Narrow Zen Mode

The current Zen mode fills the entire screen, making the lines very long.
It would be better IMO if it were narrow and centered. Otherwise it is quite hard to use on a wide screen.

Lists don't nest when tab-indented

This is a common feature that all markdown editors I am aware of and tried have in common.Shouldn't this be here as well?

Custom stylesheet for output

I am using Markdown in a couple of minimalist websites: authors write markdown, files are uploaded and user will read the text converted to HTML.

The process has a flaw, though: the websites have particular styles, and authors usually have to iterate one or two times before getting things as they want (usually this means fixing a couple of paragraphs, links, etc).

Having an offline markdown editor is great, but it would be even greater if I could provide the authors a template of the website, including HTML and CSS, and they could use that template in their editor to have a preview of the final result.

You could provide a standardized format for templates and a directory in the Moeditor root (or in the settings dialog) where the templates could be installed, something like:

Moeditor\
    templates\ 
        mySite1\
            index.html
            style.css

and have an "entry point" in the index.html where the rendered markdown would be placed.

Would you consider this as a possible enhancement to Moeditor?

A JavaScript error occurred in the main process

Uncaught Exception:
Error: EACCES: permission denied, open '/Users/***/.config/configstore/Moeditor.json'
You don't have access to this file.

at Error (native)
at Object.fs.openSync (fs.js:640:18)
at Object.module.(anonymous function) as openSync
at Object.fs.readFileSync (fs.js:508:33)
at Object.fs.readFileSync (ELECTRON_ASAR.js:500:29)
at Object.get (/Applications/Moeditor.app/Contents/Resources/app.asar/node_modules/configstore/index.js:35:26)
at Object.Configstore (/Applications/Moeditor.app/Contents/Resources/app.asar/node_modules/configstore/index.js:28:44)
at MoeditorApplication.run (/Applications/Moeditor.app/Contents/Resources/app.asar/app/moe-app.js:53:23)
at App.app.on (/Applications/Moeditor.app/Contents/Resources/app.asar/app/index.js:34:9)
at emitOne (events.js:101:20)

Can you please support footnote and TOC and UML diagrams

check with stackedit welcome document, footnote is not support yet. can you please support it ?

And if UML diagrams can be support, that will be perfect.

Code with $ start character

$this->title = "foo";

$ prevent code synthax for the line and all the lines after.

how to use relative file path when inserting images

As far as I tried, a file path like this would work

![encoded-jwt](/home/username//technical_writing/encoded-jwt3.png)

but these following relative path would not:

![encoded-jwt](encoded-jwt3.png)

or

![encoded-jwt](./encoded-jwt3.png)

although this image file sits along with my markdown file.

Hope relative file path is supported, and thanks so much for your awesome work!