Concordant Markdown Editor

The Concordant markdown editor is a collaborative markdown editor React component build on top of the MDEditor React component. This initial component has become collaborative thanks to features provided by the Concordant platform.

Requirements (versions)

This project has been tested on Node.js v14.15.0+ using NPM v6.14.8+. It might work with older Node and NPM versions.

Use as a React component

Install the package:

npm i @concordant/c-markdown-editor

Import the c-client and the component in your project:

import { client } from "@concordant/c-client";
import CMDEd from "@concordant/c-markdown-editor";

Open a session and a collection (replace with your database name, the url of your c-service and credentials):

let session = client.Session.Companion.connect(<dbName>, <serviceUrl>, <credentials>);
let collection = session.openCollection("mdeditor", false);

Use the Markdown Editor component:

<CMDEd session={session} collection={collection} />

You can provide the name of the document with docName parameter (optional).

Standalone editor

A demo standalone application is included in the editor source repository.

Install Project dependencies

Clone the Git repository, and run inside:

npm install

This will install all dependencies.

Configuration

Some parameters are configurable and stored in the file src/config.json:

• serverUrl: is the url of the c-service that should be used;
• dbName: is the name of the database you want to store your content in.

Run the application

Go to project root directory and:

npm start

This will run the app in the development mode.

Open http://localhost:3000 to view it in the browser. The page will reload if you make edits.

To make a production build with the updated configuration, run:

npm run build

This will build the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!