https://github.com/fincs/gendocs

AutoHotkey documentation generator
https://github.com/fincs/gendocs

Last synced: 12 months ago
JSON representation

AutoHotkey documentation generator

• Host: GitHub
• URL: https://github.com/fincs/gendocs
• Owner: fincs
• Created: 2011-09-25T20:31:27.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2014-03-15T19:20:26.000Z (over 12 years ago)
• Last Synced: 2025-03-02T23:30:23.553Z (over 1 year ago)
• Language: AutoHotkey
• Homepage: http://ahkscript.org/boards/viewtopic.php?f=6&t=1797
• Size: 164 KB
• Stars: 23
• Watchers: 11
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
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 `
...
`.

- **In-paragraph line breaks**: end a line with two spaces. Equivalent to HTML `
`.

- **Headings**: start a line with up to three hash (`#`) characters, followed by space. Equivalent to HTML `...`.

- **Emphasis marks**: \*...\*. Equivalent to HTML `...`.

- **Strong emphasis marks**: \*\*...\*\*. Equivalent to HTML `...`.

- **Inline code marks**: \`...\`. Equivalent to HTML `...`.

- **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 `
...
...
...
`.

- **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 `
...
` and `
...
` respectively.

- **Escape sequences**: the sequences \\\*, \\\`, \\\[, \\\], \\\! and \\\\ are recognized, and yield literal characters.

- **Links**: `[Link text](Link URL)`. Equivalent to HTML `...`.

- **Images**: `![Image ALT text](Image file name)`. Equivalent to HTML ``.


Todo list

---------

- "Related" section support

- Better AutoHotkey code comment highlighter

- CHM generation