Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.13 KB

README.md

File metadata and controls

33 lines (20 loc) · 1.13 KB
Raw

docs

This is the CoderBot documentation repository: a Vue.js application using VuePress (1.x alpha).

The development is done on the dev branch, since master is hosting the production build, served by GitHub pages (automatically deployed by an npm script, see package.json).

Image assets are hosted using Git LFS. Before cloning this repository, be sure you have it installed.

git clone https://github.com/CoderBotOrg/docs.git
npm install

Deploy

Push to the main branch.

Development

Install node, then run:

# npm i
# npm run docs:dev

License

The codebase is available under the terms of GNU General Public License, version 3.

The VuePress theme we use is based on the default one, released under the MIT License.

If not differently specified, blog posts, pages, documentation and contents (Text and markdown files, assets) are licensed under the Creative Commons Attribution Share Alike 4.0 International license (CC-BY-SA-4.0).