Popularity
3.0
Stable
Activity
0.0
Stable
881
22
62

Description

Monod is a (relatively) secure and offline-first Markdown editor we built at TailorDev in order to learn React.js (and a bunch of JavaScript tools/libraries). We mainly dedicated two Le lab sessions to this project:

Code Quality Rank: L4
Programming language: JavaScript
License: MIT License
Tags: Editors    
Latest version: v4.2.0

Monod alternatives and similar libraries

Based on the "Editors" category.
Alternatively, view Monod alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of Monod or a related project?

Add another 'Editors' Library

README

Monod

Greenkeeper badge

Circle CI

Build Status


Hi! I'm Monod, the Markdown Editor!

Monod is a (relatively) secure and offline-first Markdown editor we have built at TailorDev in order to learn React.js (and a bunch of other JavaScript tools and libraries). We dedicated two Le lab sessions to build the foundations of Monod:


Usage

Either use our public instance at: https://monod.lelab.tailordev.fr/, or self-host Monod at home, on your server, or even on Heroku:

Deploy to
Heroku

Documentation

Documentation can be found in the [doc/](doc/writing.md) directory.

Installation

Production

$ git clone https://github.com/TailorDev/monod.git
$ npm install #Β will run `npm run build`
$ npm prune --production

We use this Dockerfile to run Monod in production (which runs npm run start from the Monod root directory).

Development

$ git clone https://github.com/TailorDev/monod.git
$ npm install
$ npm run dev

The last command runs the development server at http://localhost:8080, and uses Hot Module Replacement. You can override the default host and port through the env variables HOST and PORT.

You can also start the server by running:

$ MONOD_DATA_DIR=/path/to/data npm run start

MONOD_DATA_DIR is an environment variable that configures where the server reads and writes Monod's data. It defaults to ./data/ (so be sure to create that directory if you start the server with just npm run start).

You are all set!

Other Commands

npm run build

Builds the client-side application in build/ (production ready)

npm run stats

Webpack build + generate a JSON file with metrics. We blogged about why this can be useful.

npm run lint

Runs ESLint.

npm run lint:fix

Fix all ESLint problems.

Requirements

We use node 8.0+ and npm 5.0+.

Contributing

Please, see the [CONTRIBUTING](CONTRIBUTING.md) file.

Running the Tests

$ npm run test

You can also "watch" them:

$ npm run test:watch

Code coverage is available by running:

$ npm run cov

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file.

License

Monod is released under the MIT License. See the bundled [LICENSE](LICENSE.md) file for details.


*Note that all licence references and agreements mentioned in the Monod README section above are relevant to that project's source code only.