https://github.com/myterminal/organism

A live-preview editor for org and more
https://github.com/myterminal/organism

live-preview org

Last synced: 1 day ago
JSON representation

A live-preview editor for org and more

• Host: GitHub
• URL: https://github.com/myterminal/organism
• Owner: myTerminal
• License: gpl-3.0
• Created: 2017-09-22T19:58:39.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-08-13T19:30:17.000Z (over 2 years ago)
• Last Synced: 2024-11-16T12:28:39.770Z (2 months ago)
• Topics: live-preview, org
• Language: JavaScript
• Homepage: https://myTerminal.github.io/organism
• Size: 1.68 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# organism

[![Build Status](https://travis-ci.org/myTerminal/organism.svg?branch=master)](https://travis-ci.org/myTerminal/organism)

[![Code Climate](https://codeclimate.com/github/myTerminal/organism.png)](https://codeclimate.com/github/myTerminal/organism)

[![js-myterminal-style](https://img.shields.io/badge/code%20style-myterminal-blue.svg)](https://www.npmjs.com/package/eslint-config/myterminal)

[![Coverage Status](https://img.shields.io/coveralls/myTerminal/organism.svg)](https://coveralls.io/r/myTerminal/organism?branch=master)  

[![License](https://img.shields.io/badge/LICENSE-GPL%20v3.0-blue.svg)](https://www.gnu.org/licenses/gpl.html)  

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Y8Y5E5GL7)

A live-preview editor for org and more

You can try it online: [https://myTerminal.github.io/organism](https://myTerminal.github.io/organism)

## Features

* Live-preview

* Simplistic interface, even works on mobile devices

* Multiple layout options

* Works offline

* Export preview as an HTML file

* Supports the following languages

  * [org](http://orgmode.org/manual/Document-Structure.html)

  * [Markdown](https://daringfireball.net/projects/markdown)

  * [ReStructuredText](http://docutils.sourceforge.net/rst.html)

  * [TxStyle](https://txstyle.org)

  * [Creole](https://en.wikipedia.org/wiki/Creole_(markup))

  * [BBCode](https://www.phpbb.com/community/help/bbcode)

## To-do

* Add support for more languages

## Running tests

Download or clone the project to your local system, run an `npm install` before you could run tests. At the root directory of the project,

* For unit tests, run `npm test`

* For functional tests, run `npm run test-ui`