Customize Markdown

Customize Markdown

Mind Elixir supports markdown rendering in nodes. You can use the built-in simple parser or integrate a full-featured markdown library.

1. Default Behavior

By default, Mind Elixir does not parse markdown. You must provide a parsing function in the options to enable it.

2. Using a Custom Parsing Function

You can implement a simple replacement function if you only need basic formatting (bold, italic, code).

let mind = new MindElixir({
  // ... other options
  markdown: text => {
    // Simple regex replacements
    return text
      .replace(/\*\*(.*?)\*\*/g, '<strong>$1</strong>')
      .replace(/\*(.*?)\*/g, '<em>$1</em>')
      .replace(/`(.*?)`/g, '<code>$1</code>')
  },
})

3. Integrating with Third-Party Libraries

For full markdown support, it is recommended to use a library like marked or markdown-it.

Example with marked

First, install the library:

npm i marked

Then, use it in your initialization:

import { marked } from 'marked'
import MindElixir from 'mind-elixir'

let mind = new MindElixir({
  // ... other options
  markdown: text => marked(text),
})

This will render the node content as HTML generated by the markdown parser.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.