deploy: 78a8662a796a6cfd021a611263116925dec1e3b9

versions/document-lua/docs/nature/index.xml

@@ -1,10 +1,16 @@
 <?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>dirs.setOld(d) Sets the old directory string.
 Parameters d string
-dirs.push() Add d to the recent directories list.
+dirs.push(dir) Add dir to the recent directories list.
-Parameters This function has no parameters.
+Parameters dir string
-dirs.peak(num) Look at num amount of recent directories, starting from the latest.
+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.
 Parameters num number
-dirs.recent(idx) Get entry from recent directories list based on index.
+dirs.recent(idx) Get entry from recent directories list based on index.</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>doc.renderInfoBlock(type, text) Renders an info block. An info block is a block of text with an icon and styled text block.
-Parameters idx number</description></item></channel></rss>
+Parameters type string
+Type of info block. The only one specially styled is the warning.
+text string
+doc.highlight(text) Performs basic Lua code highlighting.
+Parameters text string
+Code/text to do highlighting on.
+doc.renderCodeBlock(text) 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.</description></item></channel></rss>

versions/document-lua/index.xml

@@ -47,14 +47,20 @@ For the latest stable release, check here: https://github.com/Rosettea/Hilbish/r
 Usage of the Bait module consists of userstanding event-driven architecture, but it&amp;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 &amp;#39;commander&amp;#39; 2 3commander.register(&amp;#39;hello&amp;#39;, function(args, sinks) 4 sinks.out:writeln &amp;#39;Hello world!&amp;#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>dirs.setOld(d) Sets the old directory string.
 Parameters d string
-dirs.push() Add d to the recent directories list.
+dirs.push(dir) Add dir to the recent directories list.
-Parameters This function has no parameters.
+Parameters dir string
-dirs.peak(num) Look at num amount of recent directories, starting from the latest.
+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.
 Parameters num number
-dirs.recent(idx) Get entry from recent directories list based on index.
+dirs.recent(idx) Get entry from recent directories list based on index.</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>doc.renderInfoBlock(type, text) Renders an info block. An info block is a block of text with an icon and styled text block.
-Parameters idx number</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&amp;rsquo;s standard library has some I/O functions, they&amp;rsquo;re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does.
+Parameters type string
+Type of info block. The only one specially styled is the warning.
+text string
+doc.highlight(text) Performs basic Lua code highlighting.
+Parameters text string
+Code/text to do highlighting on.
+doc.renderCodeBlock(text) 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.</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&amp;rsquo;s standard library has some I/O functions, they&amp;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) -&amp;gt; string Returns an absolute version of the path. basename(path) -&amp;gt; string Returns the &amp;ldquo;basename,&amp;rdquo; or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish&amp;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() -&amp;gt; table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&amp;gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&amp;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) -&amp;gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&amp;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) -&amp;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.