docs_gm
The fantastic documentation generator for GameMaker:Studio and GameMaker Studio 2
Last updated 9 months ago by jhm-ciberman .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install docs_gm 
SYNC missed versions from official npm registry.

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

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

Current Tags

  • 4.2.1                                ...           latest (9 months ago)

18 Versions

  • 4.2.1                                ...           9 months ago
  • 4.2.0                                ...           9 months ago
  • 4.1.0                                ...           10 months ago
  • 4.0.0                                ...           10 months ago
  • 3.1.2                                ...           a year ago
  • 3.1.1                                ...           2 years ago
  • 3.1.0                                ...           2 years ago
  • 3.0.0                                ...           2 years ago
  • 1.2.1                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.1.2                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.1                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
  • 0.2.0                                ...           3 years ago
  • 0.1.2                                ...           3 years ago
  • 0.1.1                                ...           3 years ago
  • 0.1.0                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 2
Dependencies (15)
Dev Dependencies (17)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |