sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

docs: [ci] generate new docs

pull/234/merge
TorchedSammy 2023-04-15 14:36:56 +00:00 committed by github-actions[bot]
parent 485306fbe2
commit 6729ecddea
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api/hilbish/_index.md
View File

@ -49,6 +49,14 @@ Line highlighter handler. This is mainly for syntax highlighting, but in
reality could set the input of the prompt to *display* anything. The reality could set the input of the prompt to *display* anything. The
callback is passed the current line and is expected to return a line that callback is passed the current line and is expected to return a line that
will be used as the input display. will be used as the input display.
Note that to set a highlighter, one has to override this function.
Example:
```
function hilbish.highlighter(line)
return line:gsub('"%w+"', function(c) return lunacolors.green(c) end)
end
```
This code will highlight all double quoted strings in green.
### hinter(line, pos) ### hinter(line, pos)
The command line hint handler. It gets called on every key insert to The command line hint handler. It gets called on every key insert to

8
emmyLuaDocs/hilbish.lua
View File

@ -79,6 +79,14 @@ function hilbish.goro(fn) end
--- reality could set the input of the prompt to *display* anything. The --- reality could set the input of the prompt to *display* anything. The
--- callback is passed the current line and is expected to return a line that --- callback is passed the current line and is expected to return a line that
--- will be used as the input display. --- will be used as the input display.
--- Note that to set a highlighter, one has to override this function.
--- Example:
--- ```
--- function hilbish.highlighter(line)
--- return line:gsub('"%w+"', function(c) return lunacolors.green(c) end)
--- end
--- ```
--- This code will highlight all double quoted strings in green.
--- @param line string --- @param line string
function hilbish.highlighter(line) end function hilbish.highlighter(line) end