Contribution Guidelines

Thank you for considering to help this project.

We welcome all support, whether on bug reports, feature requests, code, design, reviews, tests, documentation, and more.

Development

Install

Clone the project on your computer, and install Node. This project also uses nvm.

nvm install
# Then, install all project dependencies.
npm install

Working on the project

Everything mentioned in the installation process should already be done.

cd website
npm run start

Releases

The website is automatically published on every push to main, with Netlify. The search engine index is automatically rebuilt every 24hrs. Full config: algolia/docsearch-configs:draftail.json

Favicons

Favicons generated with RealFaviconGenerator.

Original pencil icon is the Noun project crayon dedicated to the public domain (CC0) by D. Charbonnier.

Icons

The wesite’s icons come from IcoMoon. Emojis come from FxEmojis.

Static editor content

The demo site contains static content exported with draftjs_exporter. It is placed there for SEO, and also to make the loading experience nicer.

To regenerate it, get the serialised ContentState for the index page's editor (in sessionStorage), go to the Draftail playground, and place the ContentState in the sessionStorage value of that editor.

Content

• Always use relative file links to .md files inside Markdown docs to preserve link validation, and in-editor file navigation.