Skip to content

markedjs/marked-extension-template

Repository files navigation

TODO:

  • Replace information in /README.md
  • Replace name in /rollup.config.js
  • Replace information in /package.json
  • Write extension in /src/index.js
  • Write tests in /spec/index.test.js
  • Uncomment release in /.github/workflows/main.yml

marked-|this-extension|

Usage

import {marked} from "marked";
import |thisExtension| from "marked-|this-extension|";

// or UMD script
// <script src="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script>
// <script src="https://cdn.jsdelivr.net/npm/marked-|this-extension|/lib/index.umd.js"></script>

const options = {
	// |default options|
};

marked.use(|thisExtension|(options));

marked.parse("|example markdown|");
// <p>|example html|</p>

options