mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-04 04:33:23 +00:00
sammyette
4150001d8b
* fix: make lua implemented hilbish interfaces documented * fix: signature link in table of contents * fix: reduce function list to match in go generated docs * fix: toc appending * docs: enable docs for hilbish.messages * feat: add description gen, and more spacing between param listing * docs: add more detailed documentation for lua modules * docs: update hilbish.messages docs * fix: add description for lua doc'd modules, remove duplicate docs * docs: add back hilbish.jobs doc * feat: generate toc for lua modules * fix: add table heading * ci: add lua docgen * docs: put dirs.old doc on 1 line
1.7 KiB
1.7 KiB
| title | description | layout | menu | ||||
|---|---|---|---|---|---|---|---|
| Module doc | command-line doc rendering | doc |
|
Introduction
The doc module contains a small set of functions used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It's only intended use is by the Greenhouse pager.
Functions
| renderCodeBlock(text) | Assembles and renders a code block. This returns |
| highlight(text) | Performs basic Lua code highlighting. |
| renderInfoBlock(type, text) | Renders an info block. An info block is a block of text with |
doc.renderInfoBlock(type, text)
Renders an info block. An info block is a block of text with an icon and styled text block.
Parameters
type string
Type of info block. The only one specially styled is the warning.
text string
doc.highlight(text)
Performs basic Lua code highlighting.
Parameters
text string
Code/text to do highlighting on.