Git Product home page Git Product logo

gendocs's Introduction

GenDocs v3.0-alpha003

Introduction

GenDocs is a utility for easily creating documentation for AutoHotkey libraries.

Features

  • Functions
  • Pages
  • Classes
    • Constructors
    • Methods
    • Properties
    • Inner classes

Syntax

See Demo/TestLib.ahk to get a grasp of the syntax (TODO: document more thoroughly).

GenDocs-flavored Markdown

GenDocs uses a stripped down version of Markdown, which supports:

  • Paragraphs: blocks of text delimited by blank lines. Equivalent to HTML <p>...</p>.
  • In-paragraph line breaks: end a line with two spaces. Equivalent to HTML <br/>.
  • Headings: start a line with up to three hash (#) characters, followed by space. Equivalent to HTML <hN>...</hN>.
  • Emphasis marks: *...*. Equivalent to HTML <em>...</em>.
  • Strong emphasis marks: **...**. Equivalent to HTML <strong>...</strong>.
  • Inline code marks: `...`. Equivalent to HTML <code>...</code>.
  • Code sections: unlike standard Markdown, they use the blockquote syntax: blocks of text whose lines start with > followed by a space.
  • Unordered lists: lines that start with *. Equivalent to HTML <ul>...<li>...</li>...</ul>.
  • Ordered lists: lines that start with a number, dot and space (e.g. 1. ); or letter, dot and space (e.g. a. ). Equivalent to HTML <ol>...</ol> and <ol style="list-style-type: lower-alpha">...</ol> respectively.
  • Escape sequences: the sequences \*, \`, \[, \], \! and \\ are recognized, and yield literal characters.
  • Links: [Link text](Link URL). Equivalent to HTML <a href="...">...</a>.
  • Images: ![Image ALT text](Image file name). Equivalent to HTML <img src="..." alt="..."/>.

Todo list

  • "Related" section support
  • Better AutoHotkey code comment highlighter
  • CHM generation

gendocs's People

Contributors

fincs avatar hoppfrosch avatar infogulch avatar

Watchers

 avatar  avatar

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.