docs.mibew.org/README.md
2017-11-01 05:00:27 +03:00

22 lines
729 B
Markdown

# Mibew Messenger documentation
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 in
another way.
3. Navigate to the local copy of the repository and install npm dependencies
by running `npm install`.
4. Build the docs by running `node index.js`
Finally, static documentation will be placed in `build` directory.
## License
[Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/) License.