create-hexo-wiki v1.0.1

Hexo Wiki

Wiki-site generator based on Hexo & Git with PWA support.

Basic Usage

1. Choose a Theme & Plugins

• https://hexo.io/themes/

  • You should find out which pages must be created to enable some layout of chosen theme

• https://hexo.io/plugins/ (Some plugins have been included)

2. Create a Git repository

https://github.com/new

3. Install Hexo-wiki

npm init hexo-wiki repo_name \
    --theme name \
    --pages blog,tags \
    --plugins one,two \
    --remote https://github.com/your_id/repo_name.git

4. Setup Online services

• Static Pages host

• Auto updater (Environment varibles)

5. Upload whole site

git push

Advanced Arguments

Usage: create-hexo-wiki [options] [command]

Wiki-site generator based on Hexo & Git

Options:
    -V, --version         output the version number
    -p, --plugins <list>  Plugins to install (comma separated)
    -t, --theme <name>    A theme to install
    -p, --pages <list>    Required pages of installed theme
    -r, --remote <URL>    Git URL of a Remote repository
    -h, --help            output usage information

Commands:
    update                Update list of Plugins & Themes
    help [cmd]            display help for [cmd]

Reference Documents

• Tutorial

• Source code