Skip to content
KeystoneJS LogoKeystoneJS
👋🏻 Keystone 5 has officially moved to maintenance only. For the latest release of Keystone please visit the Keystone website.

Markdown

This is the last active development release of this package as Keystone 5 is now in a 6 to 12 month active maintenance phase. For more information please read our Keystone 5 and beyond post.

This field inserts a string path into your schema based on the Text field type implementation, and renders a Markdown editor using CodeMirror.

Usage

This package isn't included with the keystone fields package and needs to be installed:

yarn add @keystonejs/fields-markdown
# or
npm install @keystonejs/fields-markdown

Then import it, and use it like any other field:

JS
const { Markdown } = require('@keystonejs/fields-markdown');

keystone.createList('Post', {
  fields: {
    content: {
      type: Markdown,
    },
  },
});

Credit

The Editor implementation is based on SquidDev/MirrorMark.

On this page

  • Usage
  • Credit
Edit on GitHub