/docs.ctjs.rocks

Official docs of ct.js game engine

ct.js Docs Creative Commons Attribution 4.0 International

Netlify Status

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.

  1. Clone the repo with git clone https://github.com/ct-js/docs.ctjs.rocks.git;
  2. cd ./docs.ctjs.rocks/
  3. run npm install in it;
  4. 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.