mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-20 20:43:23 +00:00
deploy: 283ba533331f2ee0d7fc40ad6fb2574790357a14
This commit is contained in:
parent
ec38d9b647
commit
1d0213936f
@ -11,13 +11,7 @@ The <code>hilbish.message</code> type is a table with the following keys:
|
|||||||
<code>summary</code> (string): A short summary of the <code>text</code>.
|
<code>summary</code> (string): A short summary of the <code>text</code>.
|
||||||
<code>icon</code> (string): Unicode (preferably standard emoji) icon for the message notification
|
<code>icon</code> (string): Unicode (preferably standard emoji) icon for the message notification
|
||||||
<code>read</code> (boolean): Whether the full message has been read or not.</p><h3 id=functions class=heading>Functions
|
<code>read</code> (boolean): Whether the full message has been read or not.</p><h3 id=functions class=heading>Functions
|
||||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>|<a href=#unreadCount>unreadCount()</a>|Returns the amount of unread messages.|
|
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#unreadCount>unreadCount()</a></td><td>Returns the amount of unread messages.</td></tr><tr><td><a href=#readAll>readAll()</a></td><td>Marks all messages as read.</td></tr><tr><td><a href=#send>send(message)</a></td><td>Sends a message.</td></tr><tr><td><a href=#read>read(idx)</a></td><td>Marks a message at <code>idx</code> as read.</td></tr><tr><td><a href=#delete>delete(idx)</a></td><td>Deletes the message at <code>idx</code>.</td></tr><tr><td><a href=#clear>clear()</a></td><td>Deletes all messages.</td></tr><tr><td><a href=#all>all()</a></td><td>Returns all messages.</td></tr></tbody></table><hr><div id=all><h4 class=heading>hilbish.messages.all()
|
||||||
|<a href=#readAll>readAll()</a>|Marks all messages as read.|
|
|
||||||
|<a href=#send>send(message)</a>|Sends a message.|
|
|
||||||
|<a href=#read>read(idx)</a>|Marks a message at <code>idx</code> as read.|
|
|
||||||
|<a href=#delete>delete(idx)</a>|Deletes the message at <code>idx</code>.|
|
|
||||||
|<a href=#clear>clear()</a>|Deletes all messages.|
|
|
||||||
|<a href=#all>all()</a>|Returns all messages.|</p><hr><div id=all><h4 class=heading>hilbish.messages.all()
|
|
||||||
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns all messages.</p><h5 id=parameters class=heading>Parameters
|
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns all messages.</p><h5 id=parameters class=heading>Parameters
|
||||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
|
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
|
||||||
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes all messages.</p><h5 id=parameters-1 class=heading>Parameters
|
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes all messages.</p><h5 id=parameters-1 class=heading>Parameters
|
||||||
|
File diff suppressed because one or more lines are too long
@ -6,9 +6,7 @@
|
|||||||
used by the Greenhouse pager to render parts of the documentation pages.
|
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
|
This is only documented for the sake of it. It’s only intended use
|
||||||
is by the Greenhouse pager.</p><h3 id=functions class=heading>Functions
|
is by the Greenhouse pager.</p><h3 id=functions class=heading>Functions
|
||||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>|<a href=#renderCodeBlock>renderCodeBlock(text)</a>|Assembles and renders a code block. This returns|
|
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#renderCodeBlock>renderCodeBlock(text)</a></td><td>Assembles and renders a code block. This returns</td></tr><tr><td><a href=#highlight>highlight(text)</a></td><td>Performs basic Lua code highlighting.</td></tr><tr><td><a href=#renderInfoBlock>renderInfoBlock(type, text)</a></td><td>Renders an info block. An info block is a block of text with</td></tr></tbody></table><hr><div id=renderInfoBlock><h4 class=heading>doc.renderInfoBlock(type, text)
|
||||||
|<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|</p><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><p>Renders an info block. An info block is a block of text with
|
<a href=#renderInfoBlock class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Renders an info block. An info block is a block of text with
|
||||||
an icon and styled text block.</p><h5 id=parameters class=heading>Parameters
|
an icon and styled text block.</p><h5 id=parameters class=heading>Parameters
|
||||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>type</code> <strong><code>string</code></strong><br>Type of info block. The only one specially styled is the <code>warning</code>.</p><p><code>text</code> <strong><code>string</code></strong></p></div><hr><div id=highlight><h4 class=heading>doc.highlight(text)
|
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>type</code> <strong><code>string</code></strong><br>Type of info block. The only one specially styled is the <code>warning</code>.</p><p><code>text</code> <strong><code>string</code></strong></p></div><hr><div id=highlight><h4 class=heading>doc.highlight(text)
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Nature on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/</link><description>Recent content in Nature on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/index.xml" rel="self" type="application/rss+xml"/><item><title>Module dirs</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/</guid><description>Introduction The dirs module defines a small set of functions to store and manage directories.
|
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Nature on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/</link><description>Recent content in Nature on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/index.xml" rel="self" type="application/rss+xml"/><item><title>Module dirs</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/</guid><description>Introduction The dirs module defines a small set of functions to store and manage directories.
|
||||||
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.|
|
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.</description></item><item><title>Module doc</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/</guid><description>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&rsquo;s only intended use is by the Greenhouse pager.
|
||||||
dirs.setOld(d) Sets the old directory string.
|
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.</description></item></channel></rss>
|
||||||
Parameters d string
|
|
||||||
dirs.push(dir) Add dir to the recent directories list.</description></item><item><title>Module doc</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/</guid><description>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&rsquo;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.</description></item></channel></rss>
|
|
@ -46,12 +46,8 @@ 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.</description></item><item><title>Module bait</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/bait/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/bait/</guid><description>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!
|
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.</description></item><item><title>Module bait</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/bait/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/bait/</guid><description>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&rsquo;s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.</description></item><item><title>Module commander</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/commander/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/commander/</guid><description>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.
|
Usage of the Bait module consists of userstanding event-driven architecture, but it&rsquo;s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.</description></item><item><title>Module commander</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/commander/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/commander/</guid><description>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 &#39;commander&#39; 2 3commander.register(&#39;hello&#39;, function(args, sinks) 4 sinks.out:writeln &#39;Hello world!&#39; 5end) In this example, a command with the name of hello is created that will print Hello world!</description></item><item><title>Module dirs</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/</guid><description>Introduction The dirs module defines a small set of functions to store and manage directories.
|
1local commander = require &#39;commander&#39; 2 3commander.register(&#39;hello&#39;, function(args, sinks) 4 sinks.out:writeln &#39;Hello world!&#39; 5end) In this example, a command with the name of hello is created that will print Hello world!</description></item><item><title>Module dirs</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/dirs/</guid><description>Introduction The dirs module defines a small set of functions to store and manage directories.
|
||||||
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.|
|
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.</description></item><item><title>Module doc</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/</guid><description>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&rsquo;s only intended use is by the Greenhouse pager.
|
||||||
dirs.setOld(d) Sets the old directory string.
|
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.</description></item><item><title>Module fs</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/fs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/fs/</guid><description>Introduction The fs module provides filesystem functions to Hilbish. While Lua&rsquo;s standard library has some I/O functions, they&rsquo;re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does.
|
||||||
Parameters d string
|
|
||||||
dirs.push(dir) Add dir to the recent directories list.</description></item><item><title>Module doc</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/nature/doc/</guid><description>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&rsquo;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.</description></item><item><title>Module fs</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/fs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/fs/</guid><description>Introduction The fs module provides filesystem functions to Hilbish. While Lua&rsquo;s standard library has some I/O functions, they&rsquo;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) -&gt; string Returns an absolute version of the path. basename(path) -&gt; string Returns the &ldquo;basename,&rdquo; or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish&rsquo;s directory to dir.</description></item><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.aliases/</guid><description>Introduction The alias interface deals with all command aliases in Hilbish.
|
Functions abs(path) -&gt; string Returns an absolute version of the path. basename(path) -&gt; string Returns the &ldquo;basename,&rdquo; or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish&rsquo;s directory to dir.</description></item><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.aliases/</guid><description>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() -&gt; table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&rsquo;t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completion</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/</guid><description>Introduction The completions interface deals with tab completions.
|
Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&gt; table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&rsquo;t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completion</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.completion/</guid><description>Introduction The completions interface deals with tab completions.
|
||||||
Functions bins(query, ctx, fields) -&gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&gt; 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) -&gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
|
Functions bins(query, ctx, fields) -&gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&gt; 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) -&gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user