liz/wikijs-fork
liz/wikijs-fork
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Updated npm readme

Browse Source 
[ci skip]
This commit is contained in:
NGPixel 2017-04-29 01:15:25 -04:00
parent a5a1f57aa1
commit 15412712e1
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
npm/README.md
View File

@ -1,6 +1,4 @@
<a href="https://github.com/Requarks/wiki">
<img src="https://raw.githubusercontent.com/Requarks/wiki/master/assets/favicons/favicon-96x96.png" alt="Wiki.js" title="Wiki.js" align="right" />
</a>
![Wiki.js](https://raw.githubusercontent.com/Requarks/wiki-site/1.0/assets/images/logo.png)
# Wiki.js
@ -8,19 +6,21 @@
[![Release](https://img.shields.io/github/release/Requarks/wiki.svg?style=flat-square&maxAge=3600)](https://github.com/Requarks/wiki/releases)
[![License](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat-square)](https://github.com/requarks/wiki/blob/master/LICENSE)
This npm package is an installer for Wiki.js. For information about Wiki.js, including detailed installation steps, read the following links:
This npm package is an installer for Wiki.js.
For information about Wiki.js, including detailed installation steps, read the following links:
- [Official Website](https://wiki.requarks.io/)
- [Installation Guide](https://wiki.requarks.io/get-started.html)
- [Official Website](https://wiki.js.org/)
- [Installation Guide](https://wiki.js.org/get-started.html)
- [GitHub Repository](https://github.com/Requarks/wiki)
### Install Wiki.js
1. Create an empty folder where Wiki.js will run.
2. Launch a terminal / command prompt inside this newly created folder.
3. Run the command: `npm install wiki.js@latest`
4. Wait for the installation process to complete. This may take several minutes.
5. You'll be prompted to run the configuration wizard to finish the installation.
1. Make sure you meet all [prerequisites](https://docs.requarks.io/wiki/prerequisites).
2. Create an empty folder where Wiki.js will run.
3. Launch a terminal / command prompt inside this newly created folder.
4. Run the command: `npm install wiki.js@latest`
5. Wait for the installation process to complete. This may take several minutes.
6. You'll be prompted to run the configuration wizard to finish the installation.
The configuration wizard can also be run manually using: `node wiki configure [port]`
To start Wiki.js manually, run the command: `node wiki start`