mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-05 05:03: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
77 lines
1.7 KiB
Markdown
77 lines
1.7 KiB
Markdown
---
|
|
title: Module doc
|
|
description: command-line doc rendering
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "Nature"
|
|
---
|
|
|
|
|
|
## 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
|
|
|||
|
|
|----|----|
|
|
|<a href="#renderCodeBlock">renderCodeBlock(text)</a>|Assembles and renders a code block. This returns|
|
|
|<a href="#highlight">highlight(text)</a>|Performs basic Lua code highlighting.|
|
|
|<a href="#renderInfoBlock">renderInfoBlock(type, text)</a>|Renders an info block. An info block is a block of text with|
|
|
<hr>
|
|
<div id='renderInfoBlock'>
|
|
<h4 class='heading'>
|
|
doc.renderInfoBlock(type, text)
|
|
<a href="#renderInfoBlock" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4>
|
|
|
|
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`**
|
|
|
|
|
|
</div>
|
|
|
|
<hr>
|
|
<div id='highlight'>
|
|
<h4 class='heading'>
|
|
doc.highlight(text)
|
|
<a href="#highlight" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4>
|
|
|
|
Performs basic Lua code highlighting.
|
|
#### Parameters
|
|
`text` **`string`**
|
|
Code/text to do highlighting on.
|
|
|
|
</div>
|
|
|
|
<hr>
|
|
<div id='renderCodeBlock'>
|
|
<h4 class='heading'>
|
|
doc.renderCodeBlock(text)
|
|
<a href="#renderCodeBlock" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4>
|
|
|
|
Assembles and renders a code block. This returns
|
|
the supplied text based on the number of command line columns,
|
|
and styles it to resemble a code block.
|
|
#### Parameters
|
|
`text` **`string`**
|
|
|
|
|
|
</div>
|
|
|