MiniWiki Creator

This simple CLI is made to easily setup your own wikis with MiniWiki. To install this CLI, run the following command:

npm i @miniwiki-js/creator

Simple setup

You may create a wiki by running the following command:

npx miniwiki-creator name --version v1.2.0 # ...for example

Note

The --version argument is optional. By default, the CLI will download the latest release of MiniWiki from GitHub. Additionally, the wiki name will ALSO be the name of the new folder that the CLI will create.

Other arguments you may want to know about

1. --install (-i)

By default, this argument will be set to false, and to enable it, you enter the argument above. This will install all packages required by MiniWiki.

2. --path

By default, this argument will be set to the wiki name (but sanitised for paths). This will set the folder name for your new wiki.

Caution

Also, make sure that the folder that you are initialising the wiki in is EMPTY, otherwise some issues could occur. To ignore this, use the --ignore-no-empty-path argument.