Marpit API
The documentation of Marpit API (on main
branch) has been published at https://marpit-api.marp.app/.
Please run
yarn jsdoc
if you want to build documentation at local. It would build docs injsdoc
directory.
Documentations
Classes
Classes section is documented about public classes.
We provide Marpit
class by default export.
import Marpit from '@marp-team/marpit'
And all classes can use with named export. (Recommend if you are using TypeScript)
import { Element, Marpit, Theme, ThemeSet } from '@marp-team/marpit'
Modules (for internal)
Modules section is documented about internal modules, that is includes plugins of markdown-it and PostCSS.
Basically Marpit user should not use internal module directly.
Create plugin
Are you interested to develop third-party plugin for Marpit?
markdown-it plugin
Marpit's plugin interface has compatible with markdown-it. Please refer to the documentation of markdown-it if you want to manipulate the result of Markdown rendering in plugin.
Marpit plugin
When plugin was used through Marpit.use()
, it can access to current Marpit instance via marpit
member of the passed markdown-it instance.
@marp-team/marpit/plugin
provides a helper for creating Marpit plugin. A generated plugin promises an existance of marpit
member.
const plugin = require('@marp-team/marpit/plugin')
module.exports = plugin(({ marpit }) => {
// Plugin code (Add theme, define custom directives, etc...)
})