strapi-markdown-parser

Welcome to strapi-markdown-parser 👋

Strapi controller module to parse Markdown to HTML.

Install

yarn add strapi-markdown-parser

Use

Open your collection or single type's controller file (eg., ./api/{COLLECTION}/controllers/${COLLECTION}.js), and add the following, substituting your collection or single type's name in the place of {COLLECTION}:

const StrapiMarkdown = require('strapi-markdown-parser')
const model = require('../models/{COLLECTION}.settings.json')

const { md } = new StrapiMarkdown(model)

module.exports = {
  async find(ctx) {
    return md(await strapi.services.{COLLECTION}.find())
  },
  async findOne(ctx) {
    return md(await strapi.services.{COLLECTION}.findOne())
  }
}

Full Parameters

const { md } = StrapiMarkdown(model, types, options)

model

JSON object containing your model's settings, eg. ./api/{collection}/models/{collection}.settings.json.

types

Either an object or array specifying the types in your collection's model to transform to HTML. If an array, all fields will be treated as standard markdown and therefore paragraphs will be wrapped in <p> tags. If an object, types specified under standard will be wrapped in <p> tags, an those specified inline will not.

Defaults:

{
  standard: ['richtext'],
  inline: ['string']
}

options

Uses Marked as a parser and therefore options correspond to the Marked API.

Defaults:

{
  smartypants: true,
  headerIds: false,
  breaks: true
}

Known Issues

• Does not currently work on Strapi components, only top-level fields. Component support to come.

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

---

This README was generated with ❤️ by readme-md-generator