CatLib Documentation

This is CatLib's documentation site.The document was built using hexo. Document content in the source folder, Written in Markdown format.

Browse the online version of the CatLib documentation.

Environmental

• Nodejs(8.0.2+)
• Git(2.13.1+)

Get Starting

• Clone Documentation

$ git clone https://github.com/CatLib/catlib-en.io.git

• Installation dependency package

$ cd catlib-en.io && npm install

• Start the developer server

$ hexo s

If you open your browser and access http://localhost:4000, you should see the documentation site is up and running.

Search support(Optional)

Environmental: node-gyp

• Installation windows-build-tools(Only windows)

npm install -g -production windows-build-tools

• Installation node-gyp

npm install -g node-gyp

• Restart your command line

Installation dependency package

• Installation js-yaml

$ npm install js-yaml --save-dev

• Installation nodejieba

$ npm install nodejieba --save-dev

The search function will take effect automatically when the dependency package is installed.

Contributing

We welcome contributions in any form and your contributions will be included in the contributor list. If you want to contribute, please fork this library and submit the contribution as pull request.