https://github.com/ericoporto/ash2doc

AGS Script Header to Documentation
https://github.com/ericoporto/ash2doc

adventure-game-studio adventuregamestudio ags ags-script js npm

Last synced: about 1 month ago
JSON representation

AGS Script Header to Documentation

• Host: GitHub
• URL: https://github.com/ericoporto/ash2doc
• Owner: ericoporto
• License: mit
• Created: 2019-10-18T01:59:10.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-09-24T21:27:27.000Z (9 months ago)
• Last Synced: 2025-09-30T11:58:39.793Z (9 months ago)
• Topics: adventure-game-studio, adventuregamestudio, ags, ags-script, js, npm
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/ash2doc
• Size: 71.3 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ash2doc

From ashes to documentation, turn AGS Script Header files into friendly text.

Supports Markdown and BBCode (AGS Forum Markup! Not ready yet, but planned).

## Install

Just install directly from npm:

`npm install -g ash2doc`

## Build

after you git clone this repo, just type `npm link` on the folder. This should

add an `ash2doc` command to your path. Type `npm unlink` to remove it.

## Usage

```

Usage: ash2doc  [options]

Commands:

  ash2doc mark  Extract .ash comments to Markdown

Options:

  --version    Show version number                                     [boolean]

  -f, --file   Load a file                                            [required]

  -l, --level  Initial header level

  -h, --help   Show help                                               [boolean]

Examples:

  ash2doc mark -f foo.ash  Turns comments in the given .ash file to markdown

copyright 2019

```

## License and author

This utility is created by Érico Vieira Porto and is MIT Licensed.

See [`LICENSE`](LICENSE) for more details.