docs_gm

![Join the chat at https://gitter.im/docs_gm/Lobby](https://gitter.im/docs_gm/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
![Greenkeeper badge](https://greenkeeper.io/)
![npm](https://www.npmjs.com/package/docs_gm)
![npm](https://www.npmjs.com/package/docs_gm)
![Build Status](https://travis-ci.org/jhm-ciberman/docs_gm)
![Coverage Status](https://coveralls.io/github/jhm-ciberman/docs_gm?branch=master)
![Maintainability](https://codeclimate.com/github/jhm-ciberman/docs_gm/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:

- Tweenline 2 Animation Engine for GMS2
- Gesture Recognition Engine for GMS1/GMS2
- Sonic for GMS
- Send me an email to jhm (dot) ciberman (at) gmail (dot) com, or create a new Issue/PR to add your project here!

Get started!

Check the project wiki to get started!

- Getting Started
- Changing the theme (template) of the documentation-of-the-documentation)
- Creating custom templates
- Documentation for folders
- docs_gm.json configuration file
- Contribute with docs_gm

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

- Javier "Ciberman" Mora (@jhm-ciberman) Maintainer
- Peter Hagen (@phgn0)