zestedesavoir / lime-editor

Lime Editor will be a web-based Markdown editor, built using CodeMirror 6 and Web Components. (Far from ready yet.)

Lime Markdown Editor

Lime Editor is a web-based Markdown editor for Zeste de Savoir or any other project, built using TypeScript and LitElement.

This project is in very early stage and is far from working today.

Objectives of this project

We aim to build an efficient Markdown editor for Zeste de Savoir, where huge contents are being written. Some concepts were written in French in this pull-request.

How to use

Too early; please come back later.

How to contribute

This project is governed by Zeste de Savoir's Code of Conduct.

Setup

Install dependencies and run dev to build code in watch mode and serve files on a local webserver.

npm i
npm run dev

Then, go to http://127.0.0.1:8000/demo.

Testing

This sample uses Karma, Chai, Mocha, and the open-wc test helpers for testing. See the open-wc testing documentation for more information.

Tests can be run with the test script:

npm test

Linting

To lint the project run:

npm run lint

# or, to auto-fix if possible
npm run lint:fix

Documentation

This project includes a simple website generated with the eleventy static site generator and the templates and pages in /docs-src. The site is generated to /docs.

npm run docs

To work on the documentation locally in watch mode, run:

npm run docs:dev

The site will usually be served at http://127.0.0.1:8000 (or 8001 if the port is already used).