From ec38d9b6472d30e7f9a924515fe9e7c20b6e9bfe Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Thu, 20 Mar 2025 02:06:35 +0000 Subject: [PATCH] deploy: fd43945c96c34448a5333545d2420936efadedd8 --- .../docs/api/hilbish/hilbish.messages/index.html | 8 +++++++- versions/document-lua/docs/nature/dirs/index.html | 6 +++++- versions/document-lua/docs/nature/doc/index.html | 4 +++- versions/document-lua/docs/nature/index.xml | 14 +++++--------- versions/document-lua/index.xml | 14 +++++--------- 5 files changed, 25 insertions(+), 21 deletions(-) diff --git a/versions/document-lua/docs/api/hilbish/hilbish.messages/index.html b/versions/document-lua/docs/api/hilbish/hilbish.messages/index.html index 93fba58..ea17142 100644 --- a/versions/document-lua/docs/api/hilbish/hilbish.messages/index.html +++ b/versions/document-lua/docs/api/hilbish/hilbish.messages/index.html @@ -11,7 +11,13 @@ The hilbish.message type is a table with the following keys: summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.

Functions -

hilbish.messages.all() +

|unreadCount()|Returns the amount of unread messages.| +|readAll()|Marks all messages as read.| +|send(message)|Sends a message.| +|read(idx)|Marks a message at idx as read.| +|delete(idx)|Deletes the message at idx.| +|clear()|Deletes all messages.| +|all()|Returns all messages.|

hilbish.messages.all()

Returns all messages.

Parameters

This function has no parameters.

hilbish.messages.clear()

Deletes all messages.

Parameters diff --git a/versions/document-lua/docs/nature/dirs/index.html b/versions/document-lua/docs/nature/dirs/index.html index ff65796..e5cfbf3 100644 --- a/versions/document-lua/docs/nature/dirs/index.html +++ b/versions/document-lua/docs/nature/dirs/index.html @@ -4,7 +4,11 @@

Module dirs

internal directory management

Introduction

The dirs module defines a small set of functions to store and manage directories.

Functions -

dirs.setOld(d) +

|recent(idx)|Get entry from recent directories list based on index.| +|pop(num)|Remove the specified amount of dirs from the recent directories list.| +|peak(num)|Look at num amount of recent directories, starting from the latest.| +|push(dir)|Add dir to the recent directories list.| +|setOld(d)|Sets the old directory string.|

dirs.setOld(d)

Sets the old directory string.

Parameters

d string

dirs.push(dir)

Add dir to the recent directories list.

Parameters diff --git a/versions/document-lua/docs/nature/doc/index.html b/versions/document-lua/docs/nature/doc/index.html index f898c7f..6d6b64f 100644 --- a/versions/document-lua/docs/nature/doc/index.html +++ b/versions/document-lua/docs/nature/doc/index.html @@ -6,7 +6,9 @@ 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 -

doc.renderInfoBlock(type, text) +

|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) diff --git a/versions/document-lua/docs/nature/index.xml b/versions/document-lua/docs/nature/index.xml index 4caf5da..e00aefc 100644 --- a/versions/document-lua/docs/nature/index.xml +++ b/versions/document-lua/docs/nature/index.xml @@ -1,11 +1,7 @@ Nature on Hilbishhttps://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/Recent content in Nature on HilbishHugo -- gohugo.ioen-usModule dirshttps://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/Introduction The dirs module defines a small set of functions to store and manage directories. -Functions dirs.setOld(d) Sets the old directory string. +Functions |recent(idx)|Get entry from recent directories list based on index.| |pop(num)|Remove the specified amount of dirs from the recent directories list.| |peak(num)|Look at num amount of recent directories, starting from the latest.| |push(dir)|Add dir to the recent directories list.| |setOld(d)|Sets the old directory string.| +dirs.setOld(d) Sets the old directory string. Parameters d string -dirs.push(dir) Add dir to the recent directories list. -Parameters dir string -dirs.peak(num) Look at num amount of recent directories, starting from the latest. This returns a table of recent directories, up to the num amount. -Parameters num number -dirs.pop(num) Remove the specified amount of dirs from the recent directories list.Module dochttps://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/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 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. \ No newline at end of file +dirs.push(dir) Add dir to the recent directories list.Module dochttps://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/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. \ No newline at end of file diff --git a/versions/document-lua/index.xml b/versions/document-lua/index.xml index 5304de4..51385a9 100644 --- a/versions/document-lua/index.xml +++ b/versions/document-lua/index.xml @@ -46,16 +46,12 @@ You can download both at any time, but note that the development builds may have For the latest stable release, check here: https://github.com/Rosettea/Hilbish/releases/latest For a development build: https://nightly.link/Rosettea/Hilbish/workflows/build/master Compiling To read the steps for compiling Hilbish, head over to the GitHub repository.Module baithttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/bait/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/bait/Introduction Bait is the event emitter for Hilbish. Much like Node.js and its events system, many actions in Hilbish emit events. Unlike Node.js, Hilbish events are global. So make sure to pick a unique name! Usage of the Bait module consists of userstanding event-driven architecture, but it’s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.Module commanderhttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/commander/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/commander/Introduction Commander is the library which handles Hilbish commands. This makes the user able to add Lua-written commands to their shell without making a separate script in a bin folder. Instead, you may simply use the Commander library in your Hilbish config. 1local commander = require 'commander' 2 3commander.register('hello', function(args, sinks) 4 sinks.out:writeln 'Hello world!' 5end) In this example, a command with the name of hello is created that will print Hello world!Module dirshttps://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/Introduction The dirs module defines a small set of functions to store and manage directories. -Functions dirs.setOld(d) Sets the old directory string. +Functions |recent(idx)|Get entry from recent directories list based on index.| |pop(num)|Remove the specified amount of dirs from the recent directories list.| |peak(num)|Look at num amount of recent directories, starting from the latest.| |push(dir)|Add dir to the recent directories list.| |setOld(d)|Sets the old directory string.| +dirs.setOld(d) Sets the old directory string. Parameters d string -dirs.push(dir) Add dir to the recent directories list. -Parameters dir string -dirs.peak(num) Look at num amount of recent directories, starting from the latest. This returns a table of recent directories, up to the num amount. -Parameters num number -dirs.pop(num) Remove the specified amount of dirs from the recent directories list.Module dochttps://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/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 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.Module fshttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/fs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/fs/Introduction The fs module provides filesystem functions to Hilbish. While Lua’s standard library has some I/O functions, they’re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does. +dirs.push(dir) Add dir to the recent directories list.Module dochttps://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/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.Module fshttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/fs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/fs/Introduction The fs module provides filesystem functions to Hilbish. While Lua’s standard library has some I/O functions, they’re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does. Functions abs(path) -> string Returns an absolute version of the path. basename(path) -> string Returns the “basename,” or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish’s directory to dir.Module hilbish.aliaseshttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.aliases/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.aliases/Introduction The alias interface deals with all command aliases in Hilbish. Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -> table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -> string? Resolves an alias to its original command. Will thrown an error if the alias doesn’t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.Module hilbish.completionhttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/Introduction The completions interface deals with tab completions. Functions bins(query, ctx, fields) -> entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -> completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -> entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.Module hilbish.editorhttps://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.