Skip to content
The fantastic documentation generator for GameMaker:Studio and GameMaker Studio 2
TypeScript HTML Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
img
src
templates/docs_gm-basic
tests
.gitignore
.npmignore
.nycrc.json
.travis.yml
LICENSE
README.md
_config.yml
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

docs_gm

Join the chat at https://gitter.im/docs_gm/Lobby Greenkeeper badge npm npm Build Status Coverage Status Maintainability

The fantastic documentation generator for GameMaker:Studio and GameMaker Studio 2

docs_gm: The fantastic documentation generator for GM:S & GMS2

Features

  • Supports both GMS1 and GMS2 projects.
  • It's Multiplatform! Windows, OSX and Linux supported.
  • Easily customizable template engine.
  • OnePage and Multipage documentations.
  • Supports a lot of JSDoc tags!
  • Markdown supported!
  • Reports when some scripts are bad documented, or lack documentation.

Generated documentation example

Do you enjoy docs_gm? Click the "Star" button at the top of the github page <3

Projects using docs_gm

Documentations created with docs_gm:

Get started!

Check the project wiki to get started!

Contribute

I would love to see people interested in contributing to docs_gm. If you have some idea, or bug, you can send a Issue in the github page. Also, you can check the contribute document

Contributors

You can’t perform that action at this time.