Repository files navigation

Nice to meet you! This repo includes the official documentation ofct.js game engine. The documentation site runs onVuepress and is hosted ondocs.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.

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.

A dev server will allow you to preview your changes with live reloading. You will need toinstall node.js, if you don't have it.

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

UseGitmoji-flavored Comigoji guide for commit messages.

Except where otherwise noted, content is licensed under aCreative Commons Attribution 4.0 International License.