jhm-ciberman/docs_gm

# docs_gm

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

## ✅ Features

- Supports both GMS1 and GMS2 projects. (WARNING: It does not supports the newer GMS2.3 format. See [this issue](https://github.com/jhm-ciberman/docs_gm/issues/86) for more info)
- 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](img/docs_gm-screenshot.png)

> 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:

- [Tweenline 2 Animation Engine for GMS2](http://ciberman.net/tweenline/docs2)
- [Gesture Recognition Engine for GMS1/GMS2](https://ciberman.net/gr/docs/)
- [Sonic for GMS](https://github.com/VectorSatyr/SonicGMS)
- 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](https://github.com/jhm-ciberman/docs_gm/wiki/Getting-started)
- [Changing the theme (template) of the documentation](https://github.com/jhm-ciberman/docs_gm/wiki/Changing-the-theme-(template)-of-the-documentation)
- [Creating custom templates](https://github.com/jhm-ciberman/docs_gm/wiki/Creating-custom-templates)
- [Documentation for folders](https://github.com/jhm-ciberman/docs_gm/wiki/Documentation-for-folders)
- [docs_gm.json configuration file](https://github.com/jhm-ciberman/docs_gm/wiki/docs_gm.json-configuration-file)
- [Contribute with docs_gm](https://github.com/jhm-ciberman/docs_gm/wiki/docs_gm.json-configuration-file)

## 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](https://github.com/jhm-ciberman/docs_gm/wiki/Contribute)

## Contributors

- Javier "Ciberman" Mora ([@jhm-ciberman](https://github.com/jhm-ciberman/)) Maintainer
- Peter Hagen ([@phgn0](https://github.com/phgn0))