embed-viewer

The embed-viewer is used for converting XMind file to html and viewing pages via GitHub. It will scan the file of XMind type from your local Git Repository automatically. After that, you will receive a lot of html pages which Github Pages are going to deploy.

Requirements

• Node.js >= 8.0.0

Supported System

| Name | Supported | |:----:|:--------: | | Linux | Y | | MacOS | Y | | Win32 | Y |

Example

• Github Page Example

Install

npm i --save-dev embed-viewer

Usage

• Switch to your local project directory

cd $project

• Generate GitHub Pages

viewer -i . -o ./docs -p -e dist,src -t MyTitle -l https://logo.com/logo.svg

Commit the docs directory to your git repository

Setup GitHub Repository

1. Visit your GitHub repository.

2. Click Settings.

3. Click Pages.

4. Select the branch and the folder that pages are stored.

If all operations are done, then you can access your GitHub Pages.

More Information

viewer --help

Usage: viewer -i . -o ./docs/pages -f -e node_modules,src,...

This tool is used for converting "*.xmind" file to Gitlab pages

Options:
  -t, --title <value>     Specify the page title (default: "Embed Viewer")
  -i, --input <value>     The "*.xmind" source folder
  -o, --output <value>    The output folder where the converted pages are stored
  -p, --purge             Purge the target folder before output pages
  -e, --excludes <value>  Specify folder that will excluded during the process of scanning (default: "node_modules")
  -l, --logo <value>      Specify the logo address
  -V, --version           output the version number
  -h, --help              display help for command

LICENSE