Mibew/docs.mibew.org
1
0
Fork 0
mirror of https://github.com/Mibew/docs.mibew.org.git synced 2025-04-19 09:37:24 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add instructions about docs building

Browse Source
This commit is contained in:
Dmitriy Simushev 2015-04-15 10:41:52 +00:00
parent 9c3e1f88c1
commit 4cedb9e73c
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,3 +1,16 @@
# Mibew documentation
This repository contains documentation from docs.mibew.org site.
This repository contains documentation from https://docs.mibew.org site.
## Building the docs
There are several actions one should perform to build a local copy of the docs:
1. Install [node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/).
2. Obtain a copy of the repository using `git clone`, download button or another
way.
3. Navigate to the downloaded repository and install npm dependencies by running
`npm install`.
4. Build the site by running `node index.js`
Finally, static documentation site will be placed in `build` directory.