Dimer is an open source project and CMS to help you publish your documentation online.
We believe every project/product is incomplete without documentation.
We want to help you publish user facing documentation, without worrying about tools or code
to write.
Converts dimer markdown AST node to Vue components.
If you are using Vue to create Dimer theme, then it will be best to use this low level component to convert all markdown AST nodes into HTML.
npm i dimer-tree-vue
# Yarn
yarn add dimer-tree-vue
After installation, import the module and use it as follows.
import * as dimerTree from 'dimer-tree-vue'
import Vue from 'vue'
Vue.use(dimerTree)
// or with options
Vue.use(dimerTree, {
processFn: function (node, reRender, createElement) {
if (node.tag === 'img') {
return createElement('div', { class: 'image-container' }, reRender(node))
}
}
})
The plugin will register the component globally and can be used as follows.
<template>
<dimer-tree :node="markdownAST" />
</template>
The change log can be found in the CHANGELOG.md file.
Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.
thetutlage and contributors.
MIT License, see the included MIT file.