mirror of
https://github.com/Hilbis/Hilbish
synced 2025-05-09 22:03:22 +00:00
sammyette
e5eefb1d2d
changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
35 lines
1.0 KiB
Markdown
35 lines
1.0 KiB
Markdown
Lunacolors is an ANSI color/styling library for Lua. It is included
|
|
by default in standard Hilbish distributions to provide easy styling
|
|
for things like prompts and text.
|
|
|
|
For simple usage, a single color or style is enough. For example,
|
|
you can just use `lunacolors.blue 'Hello world'` and that'll return
|
|
blue text which you can print. This includes styles like bold,
|
|
underline, etc.
|
|
|
|
In other usage, you may want to use a format string instead of having
|
|
multiple nested functions for different styles. This is where the format
|
|
function comes in. You can used named keywords to style a section of text.
|
|
|
|
The list of arguments are:
|
|
Colors:
|
|
- black
|
|
- red
|
|
- green
|
|
- yellow
|
|
- blue
|
|
- magenta
|
|
- cyan
|
|
- white
|
|
Styles:
|
|
- bold
|
|
- dim
|
|
- italic
|
|
- underline
|
|
- invert
|
|
|
|
For the colors, there are background and bright variants. The background
|
|
color variants have a suffix of `Bg` and bright has a prefix of `bright`.
|
|
Note that appropriate camel casing has to be applied to them. So bright
|
|
blue would be `brightBlue` and background cyan would be `cyanBg`.
|