MakerFrame Documentation

English，中文

---

Here is the code repository for the MakerFrame Game Engine documentation, and you can optionally visit docs-mf.tasaed.top to view a live version.

Note: that this document is an unofficial repository, original is here.

The MakerFrame Game Engine Documentation needs your contribution!

Contribution Guide

Local Development

Requirements

• Install LTS Versions of Node.js Node.js ^20.6.0, ^22.0.0。
• Use corepack enable enable Corepack。
• Install pnpm >= 7。

Note: Node.js v18 has reached End-Of-Life on April 30, 2025.

Clone and install the project

Clone the repository locally using git clone https://github.com/TASA-Ed/MakerFrameDocs.git.

Go to the docs directory and run pnpm install to install the module.

Project operation and development

• Use pnpm docs:dev to enable the development server.
• Use pnpm build to build the project.
• Use pnpm markdownlint-cli2 "**/*.md" formatting project¹.

Preparation of tutorials

Duplicate this repository, and then you can commit the changes to this repository by turning on Pull Request.

Note:Refuse to submit content that doesn't make any sense, doesn't help others, is cluttered, promotes, plagiarizes, or attracts traffic.

Description of license

This project is licensed under CC BY-SA 4.0 and all content submitted to this project will be licensed under CC BY-SA 4.0 license.

Footnotes

1. This project uses markdownlint-cli2 to format md documents, so you need to use pnpm markdownlint-cli2 "**/*.md" to check for errors after modifying .md documents.

   The Pull Request status checks for this project also include markdownlint, except that they are neutral and can be merged normally even if an error is reported (nevertheless, we recommend that you fix all the errors before submitting the PR). ↩