ct.js Docs ![Creative Commons Attribution 4.0 International](https://camo.githubusercontent.com/72af7c8e70a45c471163e803748d0338b3b2b52f6b040804e549e4163de72a58/68747470733a2f2f692e6372656174697665636f6d6d6f6e732e6f72672f6c2f62792f342e302f38387833312e706e67)
Nice to meet you! This repo includes the official documentation of ct.js game engine. The documentation site runs on Vuepress and is hosted on docs.ctjs.rocks.
In this repo, you can:
- open an issue to highlight errors in docs, or send a pull request that will fix them;
- add a new tutorial;
- improve docs with better explanations and other stuff.
Creating pull requests
Please organize your commits so each one changes, deletes or adds one subject: a tutorial, a function, a new module, a tip, etc. Examples:
- Adding one tutorial is a commit;
- Adding a tip or improving a paragraph is a commit;
- Changing an old variable to a new one across multiple documents is a commit.
Editing & running a dev server
A dev server will allow you to preview your changes with live reloading. You will need to install node.js, if you don't have it.
- Clone the repo with
git clone https://github.com/ct-js/docs.ctjs.rocks.git
; cd ./docs.ctjs.rocks/
- run
npm install
in it; - run
npm run dev
to launch the server.
Then edit *.md
files in the ./docs
folder.
New entries can be added at .vuepress/config.js
โ themeConfig
โ sidebar
field.
Naming convention
Use Gitmoji-flavored Comigoji guide for commit messages.
License
Except where otherwise noted, content is licensed under a Creative Commons Attribution 4.0 International License.