Code Monkey home page Code Monkey logo

ash2doc's Introduction

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 <command> [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 for more details.

ash2doc's People

Contributors

dependabot[bot] avatar ericoporto avatar

Watchers

avatar avatar avatar

Forkers

happy-ferret-entertainment

ash2doc's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.