Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smolijar/emily-editor
React editor component for LMLs, like Markup or Asciidoc. The focus of the project is to provide fluent efficient interface for advanced users, who are familliar with using IDE or coding text editors.
https://github.com/smolijar/emily-editor
asciidoc component document editor lightweight-markup-language livepreview lml markdown markup modular outline react synchronized-scrolling
Last synced: about 1 month ago
JSON representation
React editor component for LMLs, like Markup or Asciidoc. The focus of the project is to provide fluent efficient interface for advanced users, who are familliar with using IDE or coding text editors.
- Host: GitHub
- URL: https://github.com/smolijar/emily-editor
- Owner: smolijar
- License: bsd-2-clause
- Created: 2017-10-16T09:45:19.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-08T23:54:12.000Z (over 6 years ago)
- Last Synced: 2024-05-06T15:14:10.881Z (7 months ago)
- Topics: asciidoc, component, document, editor, lightweight-markup-language, livepreview, lml, markdown, markup, modular, outline, react, synchronized-scrolling
- Language: JavaScript
- Size: 794 KB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - smolijar/emily-editor - React editor component for LMLs, like Markup or Asciidoc. The focus of the project is to provide fluent efficient interface for advanced users, who are familliar with using IDE or coding text editors. (react)
README
[](https://travis-ci.org/grissius/emily-editor)
[](https://david-dm.org/grissius/emily-editor)
[](https://david-dm.org/grissius/emily-editor?type=dev)
[](https://www.npmjs.com/package/emily-editor/)
Emily is a React editor component for [LML](https://en.wikipedia.org/wiki/Lightweight_markup_language)s, like Markdown or Asciidoc.
The focus of the project is to provide fluent efficient interface for advanced users, who are familliar with using IDE or coding text editors.
# About Emily
Emily is an editor for LML document formats, currently supporting few languages.
Editor works with a document-format abstraction and new modules can be added to make use of existing features:
- Syntax highlight
- Emily uses [Ace](https://ace.c9.io/) editor under the hood, see [supported languages](https://docs.c9.io/docs/supported-languages)
- Live document preview
- Review the result as you type in split screen view or just browse the preview
- Outline preview
- Section lookup in source code
- Section reordering -- drag & drop whole sections
- Command palette
- Make use of a command palette you know from coding editors
- Autosave
- Session is stored in localStorage, retrieved when lost.
Emily editor is part of an implementation for the [Git-based Wiki System](https://github.com/grissius/gitwiki-thesis) and its UI for the prototype has been [developed](https://github.com/grissius/markup-editor-ui) in cource _UI Design_ on the faculty.
# Install
```
npm install --save emily-editor
```
# Usage
1. Include `node_modules/emily-editor/dist/style.css`
2. Include `node_modules/emily-editor/dist/script.js`
3. Use component:
```js
import Emily from 'emily-editor'
// ...
ReactDOM.render(
,
document.getElementById('container')
);
```
For examples, see [pages](./pages)
## Props
### `content`
Initial content of the editor
### `language`
Language mode object.
You can use [`generateMode`](#-generatemode-) to create a mode from existing modules.
```js
import Emily, { generateMode } from 'emily-editor'
// ...
ReactDOM.render(
,
document.getElementById('container')
);
```
### `listFiles(pfx)`
List available relative files with path prefix `pfx`.
Returns a `Array` in a Promise.
This can be used for autosuggestions by a mode.
### `width`
Lock editor's width and vorbid it to fill the container.
### `height`
Lock editor's height and vorbid it to fill the container.
## Methods
### `getValue`
Return current value of the editor.
## `generateMode(input)`
Input can be either:
- name of the mode, e.g. `asciidoc`
- any file path, e.g. `foo/bar/baz.adoc`
As a result a language mode is generated.
1. If the name or the extension matches an existing LML mode, a proper full-featured mode is generated.
2. If the name or the extension matches a mode supported by Ace editor, no special features for LML are provided, but editor features syntax highlight.
3. Otherwise a plaintext editor is delivered. No syntax highlight.
### Examples
Here are some examples of using the editor with `generateMode` function.
```js
// asciidoc mode
// markdown mode
// (unsupported) js mode
// only syntax highlight, missing features
// unrecognized mode
// working in plaintext mode
```
## Language modes
Take a look at [asciidoc mode](./src/modes/asciidoc.js) example.
`name` (string)
- name of the mode
`convert` (func)
- converting function to html from the raw markup
`lineSafeInsert` (func)
- insert content in the line of markup without distorting the markup
- the more lines you can cover the better
- it is necessary to cover heading lines
`postProcess` (func)
- modify preview DOM before render
`renderJsxStyle` (func)
- add styles for preview
`excludeOutlineItem` (func)
- exclude DOM Element from the outline
`previewClassName` (string)
- set the CSS classname for the prevew container
# Online demo
https://emily-editor.herokuapp.com/
# License
Emily editor is licenced under the [BSD License](./LICENSE).