Docs.ctjs.rocks

Theme by Ct js

|

Updated: 21 Jan 2025

|

82 Stars

Official docs of ct.js game engine

Categories

Overview

The ct.js Docs is the official documentation for the ct.js game engine. The documentation site is built on Vuepress and hosted on docs.ctjs.rocks. This repository allows users to contribute by opening issues to highlight errors in the docs, sending pull requests to fix issues, adding new tutorials, and improving the documentation with better explanations and other helpful content.

Features

• Issue Reporting: Users can open issues to highlight errors in the documentation.
• Pull Requests: Users can send pull requests to fix errors or improve the documentation.
• Tutorials: Users can add new tutorials to the documentation.
• Improved Explanations: Users can enhance the documentation by providing better explanations and additional content.

Installation

To edit and preview changes to the ct.js Docs, follow these steps:

1. Install Node.js if you don’t have it installed.
2. Clone the repository using the command git clone https://github.com/ct-js/docs.ctjs.rocks.git.
3. Navigate to the cloned repository using cd ./docs.ctjs.rocks.
4. Run npm install to install the necessary dependencies.
5. Launch the development server by running npm run dev.
6. Edit the *.md files located in the ./docs folder to make changes.
7. To add new entries, modify the sidebar field in the .vuepress/config.js file.

Summary

The ct.js Docs is the official documentation for the ct.js game engine. It allows users to contribute by reporting issues, sending pull requests, and adding new tutorials. By following the provided installation instructions, users can easily edit and preview changes to the documentation. The documentation is licensed under a Creative Commons Attribution 4.0 International License.