embed-viewer's Introduction

embed-viewer

The embed-viewer is used for converting XMind file to html and viewing pages via GitHub. It will scan all the *.xmind file from your local Git Repository automatically. After that, the original file will be compiled as a format in html and then, you can deploy the Pages via Github.

Requirements

Node.js >= 8.0.0

Supported System

Name	Supported
Linux	Y
MacOS	Y
Win32	Y

Example

Github Page

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

Visit your GitHub repository.
Click Settings.
Click Pages.
Select the branch name and the folder name.

You can access your GitHub Pages after all the operations.

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