Hi! I'm Monod, the Markdown Editor!
- Introducing Le lab with “Monod”, our Markdown Editor
- Le lab #2 — Offline-First, Document Sharing, Templates: Monod is Back (not in Black)
Either use our public instance at: https://monod.lelab.tailordev.fr/, or self-host Monod at home, on your server, or even on Heroku:
Documentation can be found in the
$ git clone https://github.com/TailorDev/monod.git $ npm install # will run `npm run build` $ npm prune --production
We use this
to run Monod in production (which runs
npm run start from the Monod root
$ 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
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!
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
npm run lint:fix
Fix all ESLint problems.
node 8.0+ and
Please, see the CONTRIBUTING 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
Monod is released under the MIT License. See the bundled LICENSE file for details.