kettek / open-markup-editor

Pluggable markup text editor with stylable HTML previewing.

Open Markup Editor

An okay markup editor designed for multiple markup languages and fully customizable HTML rendering.

Built-in Features

• Markup Support:
  • Markdown via markdown-it, highly customizable via plugins
  • AsciiDoc via asciidoctor
  • Creole via npm-creole
  • Textile via textile-js
  • Org-mode via orgajs
• Render themes!
  • Comes with GitHub and a Default theme
• Custom colorization
  • Windows 10+ automatic adapting based upon current color scheme
• Custom fonts
• Automatic file reloading on change
• Full CodeMirror editor pack
  • All CodeMirror themes
  • vim, emacs, sublime keybinding support
  • Tabs or spaces, along with default spaces per tab
• And more!

Pluggability

A key feature of OME is that of modularity, made possible through NPM modules named Packs.

Through this system, four different types of packs can be created:

• Markup Packs
• Render Packs
• Editor Packs
• Extension Packs

The purpose of these is outlined in the primary packs document with further details listed on each pack type's individual documentation.

Installation

Download the latest release and install as below (or otherwise).

Arch Linux / Manjaro

Download the open-markup-editor-MAJOR.MINOR.PATCH.pacman file and install by issuing the following in the terminal:

# sudo pacman -U open-markup-editor-MAJOR.MINOR.PATCH.pacman

Mac OS

Mount the Open.Markup.Editor-MAJOR.MINOR.PATCH.dmg file and extract the Open Markup Editor.app application into wherever you wish for OME to be installed to. Once this is done, right-click the app and select Open.

Windows

Either download and run the Open.Markup.Editor.Setup-2.3.0.exe or Open.Markup.Editor-2.3.0.exe. The first file installs OME system-wide while the second file can be considered as portable.

Building

Clone this repository, then:

# cd open-markup-editor
# npm i

After this, either run npm run start to start OME for development or npm run dist to build packages/installers for your current platform.

---

... this document and those in docs/ have been happily written in Open Markup Editor.

open-markup-editor's Issues

Allow customizing default new file type

At the moment we are automatically using '.md' for new files. We should allow this to be customized to our list of extensions provided by our packs. This should be implemented in our core extension. This might necessitate having a list of supported file types/extensions held in a location other than our markup pack manager.

Reload files when file changes

It would be nice to have a system for indicating and notifying the user that an open file has been changed. Indications would potentially be marked by the file's tab's text being italicized. Notification would be upon focusing a tab (if current, simply notify).

Other functionality notes:

• Prompt should be: "Ignore", "Ignore for Now", "Reload"
• User settings:
  • Always ignore; always reload

Add Github Dark Theme

Might as well! Hopefully there's a dark mode version of the github theme library used in the current github theme.

Implement Editor font family and size overrides

As it says on the tin.

Textile markup pack

Filtered through the limited pool of parsers, the following seems the most promising: https://github.com/borgar/textile-js

Enable right-click paste on download prompt

Implement tabs bar scrolling

The entire tab bar becomes unusable when too many files are open. This is due to:

• Tabs sharing space in the same flexbox with the icons for new, open, save, as well as settings.
• The tabs flexbox space not maintaining a minimum width for each tab and overflowing beyond the space available.

To fix this, we should separate the control icons from the tabs element. Likely as such: CONTROLS, TABS, SETTINGS

TABS would then be either a grid or flexbox(w/ minimum width) that has javascript for detecting scroll area and providing left/right arrow tab scrolling of some sort.

Asciidoc markup pack

Asciidoctor seems the most prominent: https://asciidoctor.org/docs/asciidoctor.js/

Org Mode markup pack :enhancement:

First of all, thank you for sharing your work.

I would really like to see support for org mode. Just as a suggestion for another neat markup pack, if it is feasible without much effort.

Creole markup pack

Support Creole via https://www.npmjs.com/package/npm-creole

Add Tooltip Hints

Add tooltip hints to most everything interactable.

Close settings on Escape

As it says

Fix remaining process on Windows

When the application is closed via a window close event, it seems that the electron process remains running. This causes a kill to be necessary.

Add linkify options for markdown markup pack

Since this is a built-in feature of markdown-it, we should support it.

Mouse range select in default input broken

For some reason mouse-based range selection stopped working, likely with the latest minor version. Fix this ASAP

Provide pack documentation

Use last opened file for open file dialog

As it says. When a file is opened, its location should be recorded and used for future file open dialogs. Alternatively, file open dialogs could use the location of the currently opened file.

Implement Popup Error/Info/Warning System

We need a general informational popup system to notify the user of general failures or warnings based upon their actions or during initial enable/load steps. Although it may be useful to have a modal popup, for now we should have a general popup section that can hold various popups that expire after some time has passed. It seems the norm to place such a section in a floating area positioned on the bottom-right of the main window.

File->Rename

Adjacent to the Save and Save As menu items there should also be a Rename item.

Fix opening files in existing process

When files are opened via the file manager for an existing OME process on Windows, the program attempts to open passed flags as files as well. We should strip out flag-like arguments for file processing or restrict open-able files to be ones supported by the editor.

Add UI placement hooks

It'd be useful to allow packs to place UI elements in the status bar and otherwise.

Prevent Incorrect Pack Installation

Packs should be denied installation if they're installing as the incorrect type. This could be derived from the filename but should probably be stored as a field in package.json or similar.

Bi-directional text highlighting

It would be a nice feature if selected text on the left shows up on the right and vice versa. This may be outside of the functionalities of the editor and rendering systems, but would be useful.

Limit file types in save dialog

This list should be built from the supported extensions provided by all markup packs.

Find Text

Via Ctrl+F

Create Bogus Left-Right Synch

If a markup pack doesn't support line-based view synchronization then we should have a basic enable-able bogus synchronization that is based upon percentage of scroll on the editor view.

Editor<->Renderer line synch breaks on split resize

Resizing the editor/preview views will cause the line synchronization offsets to be incorrect. Resizing the window itself fixes the offsets.

Add logging

A log should be used and created in the app's userData directory. This should be writable by both the main and renderer. Possibly we should open the file for writing in main and use IPC to write from renderer.

This may require a new library akin to electron-app-settings but for logging. Will have to research if one already exists.

Show recently opened files in blank view

It would be nicer to show recently opened files in the main view when no files are opened.

Also should probably add the owl somewhere there. Potentially split 30/70 with the owl on the left and the recent files on the right.

reStructuredText markup pack

Likely using https://github.com/frantic1048/Est as that seems to be the most complete.

Spellchecker Support

It would be nice to have spellcheck support -- however, CodeMirror does not have any way, afaik, to use the native spellcheckers. This means we would have to use typo.js that forces us to include spelling dictionaries... not the best.

It might be worthwhile to look into a non-CodeMirror editor pack that supports spellchecking.

Add pack version management and updating

This shouldn't be too hard to implement. Basically we would set a GET request using github's releases API ( see https://developer.github.com/v3/repos/releases/ ), use that information to check against ours (using some semver lib), and if it is greater, prompt/automatically download and pass it to our regular install step.

• GET github repo releases
• Check semver for > than our current package
• Download latest to a temp dir and install (with prompt unless user has checked auto-update).

This will necessitate a new entry in either the pack's package.json or in the pack code in index.js. It could also be acquired automatically if the pack has a github repository set. It would simply get the repo address from package.json, append '/releases' or whatever it is, then do the above steps.

Do Alternative Render Packs Exist?

I am using the AppImage on Ubuntu and it has the Default and GitHub built in render packs.

There is some documentation about creating packs here.

However, I couldn't find any. Do any exist?

I was mainly looking for alternatives because bold displays in the default render pack but not in the GitHub pack.

And urls such as https://github.com/kettek/open-markup-editor are not rendered as links in either.

Unintuitive settings vs. normal mode

At the moment, hitting settings slides in a settings window. This is fine, however basic responses, likely because of how browsers work, make me glance and move towards the general tab view.

Solution: Either make the settings spawn a tab or hide the tab bar while the settings window is open.

Watch/notify on file deletion

This should be done in a similar manner as the file changing on-disk system. tab should likely become red(?) or similar.

pacman does not install/associate icon

As it says. Hopefully adjustable from electron-builder

Automatic Updating

This would be nice -- research electron-updater(?) as well as electron-builder's integrated updating system.

Check if files are already open

We should ensure that a file is not loaded twice. If a user wants to open multiple copies of the same file, they can use Duplicate or otherwise.

Download pack on input enter

Properly use package.json versioning in packs

Multiple versions of packs should be installable. Entries in the packs subsection should append their version information, as derived from package.json, to their proper names also from package.json