Home

Awesome

Docsify Xmind 💻

Plugin for Docsify 📘 that adds a preview of your xmind file

Key Features

Demo online

This is my first plugin - please feel welcome to suggest features or raise bugs by creating an issue.

Installation

  1. Add the jsdelivr script
<script src="//cdn.jsdelivr.net/gh/AntHubTC/docsify-xmind@1.0/example/dist/index.min.js></script>
  1. Add the jsdelivr style
<link rel="stylesheet" href="//cdn.jsdelivr.net/gh/AntHubTC/docsify-xmind@1.0/example/dist/index.min.css" />
  1. Use the following markdown to add a component to your documentation
```xmind preview
./../example/demo.xmind  <- file path
```
  1. This is what it should look like
<img src="screenshot.png" width="500px" alt="xmind Screenshot, showing a toggle bar, reveal button and preview box" />

Example

To see the small example in this repo, run the following.

git clone https://github.com/Anthubtc/docsify-xmind
cd docsify-xmind
yarn install
yarn build
yarn serve

License

This plugin uses the MIT License, summarised here.