Giter Club home page Giter Club logo

dimer-tree-vue's Introduction

Dimer App

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.


Dimer Tree Vue

Converts dimer markdown AST node to Vue components.

travis-image npm-image

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.

Installation

npm i dimer-tree-vue

# Yarn
yarn add dimer-tree-vue

Usage

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))
    }
  }
})

Using the component

The plugin will register the component globally and can be used as follows.

<template>
  <dimer-tree :node="markdownAST" />
</template>

Change log

The change log can be found in the CHANGELOG.md file.

Contributing

Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.

Authors & License

thetutlage and contributors.

MIT License, see the included MIT file.

dimer-tree-vue's People

Contributors

thetutlage avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.