Merge 5be470521f into 29e14c1aee

fixes #252

CHANGELOG.md

@@ -8,6 +8,7 @@
   - `pipe` property to check if a sink with input is a pipe (like stdin)
 - Add fuzzy search to history search (enable via `hilbish.opts.fuzzy = true`)
 - Show indexes on cdr list
+- Fix doc command not displaying correct subdocs when using shorthand api doc access (`doc api hilbish.jobs` as an example)
 - `hilbish.messages` interface (details in [#219])
 - `hilbish.notification` signal when a message/notification is sent
 - `notifyJobFinish` opt to send a notification when background jobs are
@@ -15,12 +16,14 @@ completed.
 - Allow numbered arg substitutions in aliases.
   - Example: `hilbish.alias('hello', 'echo %1 says hello')` allows the user to run `hello hilbish`
   which will output `hilbish says hello`.
+- Greenhouse
+  - Greenhouse is a pager library and program. Basic usage is `greenhouse <file>`
+  - Using this also brings enhancements to the `doc` command like easy
+  navigation of neighboring doc files.
 
 ### Fixed
-- Return the prefix when calling `hilbish.completions.call`
-
-[#219]: https://github.com/Rosettea/Hilbish/issues/219
-### Fixed
+- Fix infinite loop when navigating history without any history. [#252](https://github.com/Rosettea/Hilbish/issues/252)
+- Return the prefix when calling `hilbish.completions.call`. [#219](https://github.com/Rosettea/Hilbish/issues/219)
 - Replaced `sed` in-place editing with `grep` and `mv` for compatibility with BSD utils
 
 ## [2.1.2] - 2022-04-10

Taskfile.yaml

@@ -13,12 +13,22 @@ vars:
 
 tasks:
   default:
+    cmds:
+      - go build {{.GOFLAGS}}
+    vars:
+      GOFLAGS: '-ldflags "-s -w -X main.dataDir={{.LIBDIR}} -X main.gitCommit=$(git rev-parse --short HEAD) -X main.gitBranch=$(git rev-parse --abbrev-ref HEAD)"'
+
+  default-nocgo:
     cmds:
       - CGO_ENABLED=0 go build {{.GOFLAGS}}
     vars:
       GOFLAGS: '-ldflags "-s -w -X main.dataDir={{.LIBDIR}} -X main.gitCommit=$(git rev-parse --short HEAD) -X main.gitBranch=$(git rev-parse --abbrev-ref HEAD)"'
 
   build:
+    cmds:
+      - go build {{.GOFLAGS}}
+
+  build-nocgo:
     cmds:
       - CGO_ENABLED=0 go build {{.GOFLAGS}}
 

api.go

@@ -9,7 +9,7 @@
 // #field interactive Is Hilbish in an interactive shell?
 // #field login Is Hilbish the login shell?
 // #field vimMode Current Vim input mode of Hilbish (will be nil if not in Vim input mode)
-// #field exitCode xit code of the last executed command
+// #field exitCode Exit code of the last executed command
 package main
 
 import (
@@ -166,6 +166,9 @@ func hilbishLoad(rtm *rt.Runtime) (rt.Value, func()) {
 	util.SetField(rtm, versionModule, "release", rt.StringValue(releaseName))
 	mod.Set(rt.StringValue("version"), rt.TableValue(versionModule))
 
+	pluginModule := moduleLoader(rtm)
+	mod.Set(rt.StringValue("module"), rt.TableValue(pluginModule))
+
 	return rt.TableValue(fakeMod), nil
 }
 

cmd/docgen/docgen.go

@@ -11,6 +11,8 @@ import (
 	"strings"
 	"os"
 	"sync"
+
+	md "github.com/atsushinee/go-markdown-generator/doc"
 )
 
 var header = `---
@@ -43,6 +45,12 @@ type module struct {
 	HasTypes bool
 }
 
+type param struct{
+	Name string
+	Type string
+	Doc []string
+}
+
 type docPiece struct {
 	Doc []string
 	FuncSig string
@@ -55,6 +63,7 @@ type docPiece struct {
 	IsType bool
 	Fields []docPiece
 	Properties []docPiece
+	Params []param
 }
 
 type tag struct {
@@ -215,6 +224,17 @@ start:
 
 	fields := docPieceTag("field", tags)
 	properties := docPieceTag("property", tags)
+	var params []param
+	if paramsRaw := tags["param"]; paramsRaw != nil {
+		params = make([]param, len(paramsRaw))
+		for i, p := range paramsRaw {
+			params[i] = param{
+				Name: p.id,
+				Type: p.fields[0],
+				Doc: p.fields[1:],
+			}
+		}
+	}
 
 	for _, d := range doc {
 		if strings.HasPrefix(d, "---") {
@@ -252,6 +272,7 @@ start:
 		ParentModule: parentMod,
 		Fields: fields,
 		Properties: properties,
+		Params: params,
 	}
 	if strings.HasSuffix(dps.GoFuncName, strings.ToLower("loader")) {
 		dps.Doc = parts
@@ -412,13 +433,14 @@ func main() {
 			defer wg.Done()
 			modOrIface := "Module"
 			if modu.ParentModule != "" {
-				modOrIface = "Interface"
+				modOrIface = "Module"
 			}
+			lastHeader := ""
 
 			f, _ := os.Create(docPath)
 			f.WriteString(fmt.Sprintf(header, modOrIface, modname, modu.ShortDescription))
-			typeTag, _ := regexp.Compile(`@\w+`)
-			modDescription := typeTag.ReplaceAllStringFunc(strings.Replace(modu.Description, "<", `\<`, -1), func(typ string) string {
+			typeTag, _ := regexp.Compile(`\B@\w+`)
+			modDescription := typeTag.ReplaceAllStringFunc(strings.Replace(strings.Replace(modu.Description, "<", `\<`, -1), "{{\\<", "{{<", -1), func(typ string) string {
 				typName := typ[1:]
 				typLookup := typeTable[strings.ToLower(typName)]
 				ifaces := typLookup[0] + "." + typLookup[1] + "/"
@@ -429,32 +451,77 @@ func main() {
 				return fmt.Sprintf(`<a href="%s" style="text-decoration: none;">%s</a>`, linkedTyp, typName)
 			})
 			f.WriteString(fmt.Sprintf("## Introduction\n%s\n\n", modDescription))
-			if len(modu.Fields) != 0 {
-				f.WriteString("## Interface fields\n")
-				for _, dps := range modu.Fields {
-					f.WriteString(fmt.Sprintf("- `%s`: ", dps.FuncName))
-					f.WriteString(strings.Join(dps.Doc, " "))
-					f.WriteString("\n")
-				}
-				f.WriteString("\n")
-			}
-			if len(modu.Properties) != 0 {
-				f.WriteString("## Object properties\n")
-				for _, dps := range modu.Properties {
-					f.WriteString(fmt.Sprintf("- `%s`: ", dps.FuncName))
-					f.WriteString(strings.Join(dps.Doc, " "))
-					f.WriteString("\n")
-				}
-				f.WriteString("\n")
-			}
-
 			if len(modu.Docs) != 0 {
-				f.WriteString("## Functions\n")
+				funcCount := 0
 				for _, dps := range modu.Docs {
 					if dps.IsMember {
 						continue
 					}
-					htmlSig := typeTag.ReplaceAllStringFunc(strings.Replace(dps.FuncSig, "<", `\<`, -1), func(typ string) string {
+					funcCount++
+				}
+
+				f.WriteString("## Functions\n")
+				lastHeader = "functions"
+
+				mdTable := md.NewTable(funcCount, 2)
+				mdTable.SetTitle(0, "")
+				mdTable.SetTitle(1, "")
+
+				diff := 0
+				for i, dps := range modu.Docs {
+					if dps.IsMember {
+						diff++
+						continue
+					}
+
+					mdTable.SetContent(i - diff, 0, fmt.Sprintf(`<a href="#%s">%s</a>`, dps.FuncName, dps.FuncSig))
+					mdTable.SetContent(i - diff, 1, dps.Doc[0])
+				}
+				f.WriteString(mdTable.String())
+				f.WriteString("\n")
+			}
+
+			if len(modu.Fields) != 0 {
+				f.WriteString("## Static module fields\n")
+
+				mdTable := md.NewTable(len(modu.Fields), 2)
+				mdTable.SetTitle(0, "")
+				mdTable.SetTitle(1, "")
+
+
+				for i, dps := range modu.Fields {
+					mdTable.SetContent(i, 0, dps.FuncName)
+					mdTable.SetContent(i, 1, strings.Join(dps.Doc, " "))
+				}
+				f.WriteString(mdTable.String())
+				f.WriteString("\n")
+			}
+			if len(modu.Properties) != 0 {
+				f.WriteString("## Object properties\n")
+
+				mdTable := md.NewTable(len(modu.Fields), 2)
+				mdTable.SetTitle(0, "")
+				mdTable.SetTitle(1, "")
+
+
+				for i, dps := range modu.Properties {
+					mdTable.SetContent(i, 0, dps.FuncName)
+					mdTable.SetContent(i, 1, strings.Join(dps.Doc, " "))
+				}
+				f.WriteString(mdTable.String())
+				f.WriteString("\n")
+			}
+
+			if len(modu.Docs) != 0 {
+				if lastHeader != "functions" {
+					f.WriteString("## Functions\n")
+				}
+				for _, dps := range modu.Docs {
+					if dps.IsMember {
+						continue
+					}
+					f.WriteString(fmt.Sprintf("<hr><div id='%s'>", dps.FuncName))
+					htmlSig := typeTag.ReplaceAllStringFunc(strings.Replace(modname + "." + dps.FuncSig, "<", `\<`, -1), func(typ string) string {
 						typName := typ[1:]
 						typLookup := typeTable[strings.ToLower(typName)]
 						ifaces := typLookup[0] + "." + typLookup[1] + "/"
@@ -462,21 +529,51 @@ func main() {
 							ifaces = ""
 						}
 						linkedTyp := fmt.Sprintf("/Hilbish/docs/api/%s/%s#%s", typLookup[0], ifaces, strings.ToLower(typName))
-						return fmt.Sprintf(`<a href="%s" style="text-decoration: none;">%s</a>`, linkedTyp, typName)
+						return fmt.Sprintf(`<a href="%s" style="text-decoration: none;" id="lol">%s</a>`, linkedTyp, typName)
 					})
-					f.WriteString(fmt.Sprintf("### %s\n", htmlSig))
+					f.WriteString(fmt.Sprintf(`
+<h4 class='heading'>
+%s
+<a href="#%s" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
+`, htmlSig, dps.FuncName))
 					for _, doc := range dps.Doc {
 						if !strings.HasPrefix(doc, "---") {
 							f.WriteString(doc + "\n")
 						}
 					}
+					f.WriteString("#### Parameters\n")
+					if len(dps.Params) == 0 {
+						f.WriteString("This function has no parameters.  \n")
+					}
+					for _, p := range dps.Params {
+						isVariadic := false
+						typ := p.Type
+						if strings.HasPrefix(p.Type, "...") {
+							isVariadic = true
+							typ = p.Type[3:]
+						}
+
+						f.WriteString(fmt.Sprintf("`%s` **`%s`**", typ, p.Name))
+						if isVariadic {
+							f.WriteString(" (This type is variadic. You can pass an infinite amount of parameters with this type.)")
+						}
 						f.WriteString("  \n")
+						f.WriteString(strings.Join(p.Doc, " "))
+						f.WriteString("\n\n")
+					}
+					f.WriteString("</div>")
+					f.WriteString("\n\n")
 				}
 			}
 
 			if len(modu.Types) != 0 {
 				f.WriteString("## Types\n")
 				for _, dps := range modu.Types {
+					f.WriteString("<hr>\n\n")
 					f.WriteString(fmt.Sprintf("## %s\n", dps.FuncName))
 					for _, doc := range dps.Doc {
 						if !strings.HasPrefix(doc, "---") {
@@ -484,12 +581,18 @@ func main() {
 						}
 					}
 					if len(dps.Properties) != 0 {
-						f.WriteString("### Properties\n")
-						for _, dps := range dps.Properties {
-							f.WriteString(fmt.Sprintf("- `%s`: ", dps.FuncName))
-							f.WriteString(strings.Join(dps.Doc, " "))
-							f.WriteString("\n")
+						f.WriteString("## Object properties\n")
+
+						mdTable := md.NewTable(len(dps.Properties), 2)
+						mdTable.SetTitle(0, "")
+						mdTable.SetTitle(1, "")
+
+						for i, d := range dps.Properties {
+							mdTable.SetContent(i, 0, d.FuncName)
+							mdTable.SetContent(i, 1, strings.Join(d.Doc, " "))
 						}
+						f.WriteString(mdTable.String())
+						f.WriteString("\n")
 					}
 					f.WriteString("\n")
 					f.WriteString("### Methods\n")

docs/api/bait.md

@@ -8,27 +8,113 @@ menu:
 ---
 
 ## Introduction
-Bait is the event emitter for Hilbish. Why name it bait? Why not.
-It throws hooks that you can catch. This is what you will use if
-you want to listen in on hooks to know when certain things have
-happened, like when you've changed directory, a command has failed,
-etc. To find all available hooks thrown by Hilbish, see doc hooks.
+
+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.
+
+Examples of this are in the Hilbish default config!
+Consider this part of it:
+```lua
+bait.catch('command.exit', function(code)
+	running = false
+	doPrompt(code ~= 0)
+	doNotifyPrompt()
+end)
+```
+
+What this does is, whenever the `command.exit` event is thrown,
+this function will set the user prompt.
 
 ## Functions
-### catch(name, cb)
+|||
+|----|----|
+|<a href="#catch">catch(name, cb)</a>|Catches a hook with `name`. Runs the `cb` when it is thrown|
+|<a href="#catchOnce">catchOnce(name, cb)</a>|Same as catch, but only runs the `cb` once and then removes the hook|
+|<a href="#hooks">hooks(name) -> table</a>|Returns a table with hooks (callback functions) on the event with `name`.|
+|<a href="#release">release(name, catcher)</a>|Removes the `catcher` for the event with `name`.|
+|<a href="#throw">throw(name, ...args)</a>|Throws a hook with `name` with the provided `args`|
+
+<hr><div id='catch'>
+<h4 class='heading'>
+bait.catch(name, cb)
+<a href="#catch" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Catches a hook with `name`. Runs the `cb` when it is thrown
+#### Parameters
+`string` **`name`**  
+ummm
+
+`function` **`cb`**  
+?
+
+</div>
+
+<hr><div id='catchOnce'>
+<h4 class='heading'>
+bait.catchOnce(name, cb)
+<a href="#catchOnce" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### catchOnce(name, cb)
 Same as catch, but only runs the `cb` once and then removes the hook
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='hooks'>
+<h4 class='heading'>
+bait.hooks(name) -> table
+<a href="#hooks" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### hooks(name) -> table
 Returns a table with hooks (callback functions) on the event with `name`.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='release'>
+<h4 class='heading'>
+bait.release(name, catcher)
+<a href="#release" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### release(name, catcher)
 Removes the `catcher` for the event with `name`.
 For this to work, `catcher` has to be the same function used to catch
 an event, like one saved to a variable.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='throw'>
+<h4 class='heading'>
+bait.throw(name, ...args)
+<a href="#throw" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### throw(name, ...args)
 Throws a hook with `name` with the provided `args`
+#### Parameters
+`string` **`name`**  
+The name of the hook.
+
+`any` **`args`** (This type is variadic. You can pass an infinite amount of parameters with this type.)  
+The arguments to pass to the hook.
+
+</div>
 

docs/api/commander.md

@@ -31,16 +31,41 @@ The `sinks` parameter is a table with 3 keys: `in`, `out`,
 and `err`. The values of these is a <a href="/Hilbish/docs/api/hilbish/#sink" style="text-decoration: none;">Sink</a>.
 
 - `in` is the standard input. You can read from this sink
-to get user input. (**This is currently unimplemented.**)
+to get user input.
 - `out` is standard output. This is usually where text meant for
 output should go.
 - `err` is standard error. This sink is for writing errors, as the
 name would suggest.
 
 ## Functions
-### deregister(name)
+|||
+|----|----|
+|<a href="#deregister">deregister(name)</a>|Deregisters any command registered with `name`|
+|<a href="#register">register(name, cb)</a>|Register a command with `name` that runs `cb` when ran|
+
+<hr><div id='deregister'>
+<h4 class='heading'>
+commander.deregister(name)
+<a href="#deregister" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Deregisters any command registered with `name`
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='register'>
+<h4 class='heading'>
+commander.register(name, cb)
+<a href="#register" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### register(name, cb)
 Register a command with `name` that runs `cb` when ran
+#### Parameters
+This function has no parameters.  
+</div>
 

docs/api/fs.md

@@ -13,39 +13,141 @@ and other things, and acts an addition to the Lua standard library's
 I/O and filesystem functions.
 
 ## Functions
-### abs(path) -> string
-Gives an absolute version of `path`.
+|||
+|----|----|
+|<a href="#abs">abs(path) -> string</a>|Gives an absolute version of `path`.|
+|<a href="#basename">basename(path) -> string</a>|Gives the basename of `path`. For the rules,|
+|<a href="#cd">cd(dir)</a>|Changes directory to `dir`|
+|<a href="#dir">dir(path) -> string</a>|Returns the directory part of `path`. For the rules, see Go's|
+|<a href="#glob">glob(pattern) -> matches (table)</a>|Glob all files and directories that match the pattern.|
+|<a href="#join">join(...) -> string</a>|Takes paths and joins them together with the OS's|
+|<a href="#mkdir">mkdir(name, recursive)</a>|Makes a directory called `name`. If `recursive` is true, it will create its parent directories.|
+|<a href="#readdir">readdir(dir) -> {}</a>|Returns a table of files in `dir`.|
+|<a href="#stat">stat(path) -> {}</a>|Returns a table of info about the `path`.|
+
+<hr><div id='abs'>
+<h4 class='heading'>
+fs.abs(path) -> string
+<a href="#abs" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
+Gives an absolute version of `path`.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='basename'>
+<h4 class='heading'>
+fs.basename(path) -> string
+<a href="#basename" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### basename(path) -> string
 Gives the basename of `path`. For the rules,
 see Go's filepath.Base
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='cd'>
+<h4 class='heading'>
+fs.cd(dir)
+<a href="#cd" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### cd(dir)
 Changes directory to `dir`
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='dir'>
+<h4 class='heading'>
+fs.dir(path) -> string
+<a href="#dir" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### dir(path) -> string
 Returns the directory part of `path`. For the rules, see Go's
 filepath.Dir
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='glob'>
+<h4 class='heading'>
+fs.glob(pattern) -> matches (table)
+<a href="#glob" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### glob(pattern) -> matches (table)
 Glob all files and directories that match the pattern.
 For the rules, see Go's filepath.Glob
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='join'>
+<h4 class='heading'>
+fs.join(...) -> string
+<a href="#join" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### join(...) -> string
 Takes paths and joins them together with the OS's
 directory separator (forward or backward slash).
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='mkdir'>
+<h4 class='heading'>
+fs.mkdir(name, recursive)
+<a href="#mkdir" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### mkdir(name, recursive)
 Makes a directory called `name`. If `recursive` is true, it will create its parent directories.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='readdir'>
+<h4 class='heading'>
+fs.readdir(dir) -> {}
+<a href="#readdir" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### readdir(dir) -> {}
 Returns a table of files in `dir`.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='stat'>
+<h4 class='heading'>
+fs.stat(path) -> {}
+<a href="#stat" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### stat(path) -> {}
 Returns a table of info about the `path`.
 It contains the following keys:
 name (string) - Name of the path
 size (number) - Size of the path
 mode (string) - Permission mode in an octal format string (with leading 0)
 isDir (boolean) - If the path is a directory
+#### Parameters
+This function has no parameters.  
+</div>
 

docs/api/hilbish/_index.md

@@ -11,41 +11,131 @@ menu:
 The Hilbish module includes the core API, containing
 interfaces and functions which directly relate to shell functionality.
 
-## Interface fields
-- `ver`: The version of Hilbish
-- `goVersion`: The version of Go that Hilbish was compiled with
-- `user`: Username of the user
-- `host`: Hostname of the machine
-- `dataDir`: Directory for Hilbish data files, including the docs and default modules
-- `interactive`: Is Hilbish in an interactive shell?
-- `login`: Is Hilbish the login shell?
-- `vimMode`: Current Vim input mode of Hilbish (will be nil if not in Vim input mode)
-- `exitCode`: xit code of the last executed command
-
 ## Functions
-### alias(cmd, orig)
+|||
+|----|----|
+|<a href="#alias">alias(cmd, orig)</a>|Sets an alias of `cmd` to `orig`|
+|<a href="#appendPath">appendPath(dir)</a>|Appends `dir` to $PATH|
+|<a href="#complete">complete(scope, cb)</a>|Registers a completion handler for `scope`.|
+|<a href="#cwd">cwd() -> string</a>|Returns the current directory of the shell|
+|<a href="#exec">exec(cmd)</a>|Replaces running hilbish with `cmd`|
+|<a href="#goro">goro(fn)</a>|Puts `fn` in a goroutine|
+|<a href="#highlighter">highlighter(line)</a>|Line highlighter handler. This is mainly for syntax highlighting, but in|
+|<a href="#hinter">hinter(line, pos)</a>|The command line hint handler. It gets called on every key insert to|
+|<a href="#inputMode">inputMode(mode)</a>|Sets the input mode for Hilbish's line reader. Accepts either emacs or vim|
+|<a href="#interval">interval(cb, time) -> @Timer</a>|Runs the `cb` function every `time` milliseconds.|
+|<a href="#multiprompt">multiprompt(str)</a>|Changes the continued line prompt to `str`|
+|<a href="#prependPath">prependPath(dir)</a>|Prepends `dir` to $PATH|
+|<a href="#prompt">prompt(str, typ)</a>|Changes the shell prompt to `str`|
+|<a href="#read">read(prompt) -> input (string)</a>|Read input from the user, using Hilbish's line editor/input reader.|
+|<a href="#run">run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string)</a>|Runs `cmd` in Hilbish's sh interpreter.|
+|<a href="#runnerMode">runnerMode(mode)</a>|Sets the execution/runner mode for interactive Hilbish. This determines whether|
+|<a href="#timeout">timeout(cb, time) -> @Timer</a>|Runs the `cb` function after `time` in milliseconds.|
+|<a href="#which">which(name) -> string</a>|Checks if `name` is a valid command.|
+
+## Static module fields
+|||
+|----|----|
+|ver|The version of Hilbish|
+|goVersion|The version of Go that Hilbish was compiled with|
+|user|Username of the user|
+|host|Hostname of the machine|
+|dataDir|Directory for Hilbish data files, including the docs and default modules|
+|interactive|Is Hilbish in an interactive shell?|
+|login|Is Hilbish the login shell?|
+|vimMode|Current Vim input mode of Hilbish (will be nil if not in Vim input mode)|
+|exitCode|Exit code of the last executed command|
+
+<hr><div id='alias'>
+<h4 class='heading'>
+hilbish.alias(cmd, orig)
+<a href="#alias" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Sets an alias of `cmd` to `orig`
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='appendPath'>
+<h4 class='heading'>
+hilbish.appendPath(dir)
+<a href="#appendPath" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### appendPath(dir)
 Appends `dir` to $PATH
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='complete'>
+<h4 class='heading'>
+hilbish.complete(scope, cb)
+<a href="#complete" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### complete(scope, cb)
 Registers a completion handler for `scope`.
 A `scope` is currently only expected to be `command.<cmd>`,
 replacing <cmd> with the name of the command (for example `command.git`).
 `cb` must be a function that returns a table of "completion groups."
 Check `doc completions` for more information.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='cwd'>
+<h4 class='heading'>
+hilbish.cwd() -> string
+<a href="#cwd" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### cwd() -> string
 Returns the current directory of the shell
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='exec'>
+<h4 class='heading'>
+hilbish.exec(cmd)
+<a href="#exec" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### exec(cmd)
 Replaces running hilbish with `cmd`
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='goro'>
+<h4 class='heading'>
+hilbish.goro(fn)
+<a href="#goro" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### goro(fn)
 Puts `fn` in a goroutine
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='highlighter'>
+<h4 class='heading'>
+hilbish.highlighter(line)
+<a href="#highlighter" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### highlighter(line)
 Line highlighter handler. This is mainly for syntax highlighting, but in
 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
@@ -58,61 +148,176 @@ function hilbish.highlighter(line)
 end
 ```
 This code will highlight all double quoted strings in green.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='hinter'>
+<h4 class='heading'>
+hilbish.hinter(line, pos)
+<a href="#hinter" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### hinter(line, pos)
 The command line hint handler. It gets called on every key insert to
 determine what text to use as an inline hint. It is passed the current
 line and cursor position. It is expected to return a string which is used
 as the text for the hint. This is by default a shim. To set hints,
 override this function with your custom handler.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='inputMode'>
+<h4 class='heading'>
+hilbish.inputMode(mode)
+<a href="#inputMode" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### inputMode(mode)
 Sets the input mode for Hilbish's line reader. Accepts either emacs or vim
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='interval'>
+<h4 class='heading'>
+hilbish.interval(cb, time) -> <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" style="text-decoration: none;" id="lol">Timer</a>
+<a href="#interval" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### interval(cb, time) -> <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" style="text-decoration: none;">Timer</a>
 Runs the `cb` function every `time` milliseconds.
 This creates a timer that starts immediately.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='multiprompt'>
+<h4 class='heading'>
+hilbish.multiprompt(str)
+<a href="#multiprompt" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### multiprompt(str)
 Changes the continued line prompt to `str`
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='prependPath'>
+<h4 class='heading'>
+hilbish.prependPath(dir)
+<a href="#prependPath" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### prependPath(dir)
 Prepends `dir` to $PATH
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='prompt'>
+<h4 class='heading'>
+hilbish.prompt(str, typ)
+<a href="#prompt" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### prompt(str, typ)
 Changes the shell prompt to `str`
 There are a few verbs that can be used in the prompt text.
 These will be formatted and replaced with the appropriate values.
 `%d` - Current working directory
 `%u` - Name of current user
 `%h` - Hostname of device
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='read'>
+<h4 class='heading'>
+hilbish.read(prompt) -> input (string)
+<a href="#read" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### read(prompt) -> input (string)
 Read input from the user, using Hilbish's line editor/input reader.
 This is a separate instance from the one Hilbish actually uses.
 Returns `input`, will be nil if ctrl + d is pressed, or an error occurs (which shouldn't happen)
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='run'>
+<h4 class='heading'>
+hilbish.run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string)
+<a href="#run" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string)
 Runs `cmd` in Hilbish's sh interpreter.
 If returnOut is true, the outputs of `cmd` will be returned as the 2nd and
 3rd values instead of being outputted to the terminal.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='runnerMode'>
+<h4 class='heading'>
+hilbish.runnerMode(mode)
+<a href="#runnerMode" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### runnerMode(mode)
 Sets the execution/runner mode for interactive Hilbish. This determines whether
 Hilbish wll try to run input as Lua and/or sh or only do one of either.
 Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua),
 sh, and lua. It also accepts a function, to which if it is passed one
 will call it to execute user input instead.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='timeout'>
+<h4 class='heading'>
+hilbish.timeout(cb, time) -> <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" style="text-decoration: none;" id="lol">Timer</a>
+<a href="#timeout" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### timeout(cb, time) -> <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" style="text-decoration: none;">Timer</a>
 Runs the `cb` function after `time` in milliseconds.
 This creates a timer that starts immediately.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='which'>
+<h4 class='heading'>
+hilbish.which(name) -> string
+<a href="#which" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### which(name) -> string
 Checks if `name` is a valid command.
 Will return the path of the binary, or a basename if it's a commander.
+#### Parameters
+This function has no parameters.  
+</div>
 
 ## Types
+<hr>
+
 ## Sink
 A sink is a structure that has input and/or output to/from
 a desination.
@@ -126,7 +331,10 @@ A call with no argument will toggle the value.
 Flush writes all buffered input to the sink.
 
 #### read() -> string
-Reads input from the sink.
+Reads a liine of input from the sink.
+
+#### readAll() -> string
+Reads all input from the sink.
 
 #### write(str)
 Writes data to a sink.

docs/api/hilbish/hilbish.aliases.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.aliases
+title: Module hilbish.aliases
 description: command aliasing
 layout: doc
 menu:
@@ -11,15 +11,62 @@ menu:
 The alias interface deals with all command aliases in Hilbish.
 
 ## Functions
-### add(alias, cmd)
+|||
+|----|----|
+|<a href="#aliases.add">add(alias, cmd)</a>|This is an alias (ha) for the `hilbish.alias` function.|
+|<a href="#aliases.delete">delete(name)</a>|Removes an alias.|
+|<a href="#aliases.list">list() -> table<string, string></a>|Get a table of all aliases, with string keys as the alias and the value as the command.|
+|<a href="#aliases.resolve">resolve(alias) -> command (string)</a>|Tries to resolve an alias to its command.|
+
+<hr><div id='aliases.add'>
+<h4 class='heading'>
+hilbish.aliases.add(alias, cmd)
+<a href="#aliases.add" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 This is an alias (ha) for the `hilbish.alias` function.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='aliases.delete'>
+<h4 class='heading'>
+hilbish.aliases.delete(name)
+<a href="#aliases.delete" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### delete(name)
 Removes an alias.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='aliases.list'>
+<h4 class='heading'>
+hilbish.aliases.list() -> table\<string, string>
+<a href="#aliases.list" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### list() -> table\<string, string>
 Get a table of all aliases, with string keys as the alias and the value as the command.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='aliases.resolve'>
+<h4 class='heading'>
+hilbish.aliases.resolve(alias) -> command (string)
+<a href="#aliases.resolve" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### resolve(alias) -> command (string)
 Tries to resolve an alias to its command.
+#### Parameters
+This function has no parameters.  
+</div>
 

docs/api/hilbish/hilbish.completions.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.completions
+title: Module hilbish.completions
 description: tab completions
 layout: doc
 menu:
@@ -11,19 +11,66 @@ menu:
 The completions interface deals with tab completions.
 
 ## Functions
-### call(name, query, ctx, fields) -> completionGroups (table), prefix (string)
+|||
+|----|----|
+|<a href="#completions.call">call(name, query, ctx, fields) -> completionGroups (table), prefix (string)</a>|Calls a completer function. This is mainly used to call|
+|<a href="#completions.handler">handler(line, pos)</a>|The handler function is the callback for tab completion in Hilbish.|
+|<a href="#completions.bins">bins(query, ctx, fields) -> entries (table), prefix (string)</a>|Returns binary/executale completion candidates based on the provided query.|
+|<a href="#completions.files">files(query, ctx, fields) -> entries (table), prefix (string)</a>|Returns file completion candidates based on the provided query.|
+
+<hr><div id='completions.call'>
+<h4 class='heading'>
+hilbish.completions.call(name, query, ctx, fields) -> completionGroups (table), prefix (string)
+<a href="#completions.call" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Calls a completer function. This is mainly used to call
 a command completer, which will have a `name` in the form
 of `command.name`, example: `command.git`.
 You can check `doc completions` for info on the `completionGroups` return value.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='completions.handler'>
+<h4 class='heading'>
+hilbish.completions.handler(line, pos)
+<a href="#completions.handler" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### handler(line, pos)
 The handler function is the callback for tab completion in Hilbish.
 You can check the completions doc for more info.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='completions.bins'>
+<h4 class='heading'>
+hilbish.completions.bins(query, ctx, fields) -> entries (table), prefix (string)
+<a href="#completions.bins" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### bins(query, ctx, fields) -> entries (table), prefix (string)
 Returns binary/executale completion candidates based on the provided query.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='completions.files'>
+<h4 class='heading'>
+hilbish.completions.files(query, ctx, fields) -> entries (table), prefix (string)
+<a href="#completions.files" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### files(query, ctx, fields) -> entries (table), prefix (string)
 Returns file completion candidates based on the provided query.
+#### Parameters
+This function has no parameters.  
+</div>
 

docs/api/hilbish/hilbish.editor.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.editor
+title: Module hilbish.editor
 description: interactions for Hilbish's line reader
 layout: doc
 menu:
@@ -12,15 +12,77 @@ The hilbish.editor interface provides functions to
 directly interact with the line editor in use.
 
 ## Functions
-### getLine() -> string
+|||
+|----|----|
+|<a href="#editor.getLine">getLine() -> string</a>|Returns the current input line.|
+|<a href="#editor.getVimRegister">getVimRegister(register) -> string</a>|Returns the text that is at the register.|
+|<a href="#editor.insert">insert(text)</a>|Inserts text into the line.|
+|<a href="#editor.getChar">getChar() -> string</a>|Reads a keystroke from the user. This is in a format|
+|<a href="#editor.setVimRegister">setVimRegister(register, text)</a>|Sets the vim register at `register` to hold the passed text.|
+
+<hr><div id='editor.getLine'>
+<h4 class='heading'>
+hilbish.editor.getLine() -> string
+<a href="#editor.getLine" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Returns the current input line.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='editor.getVimRegister'>
+<h4 class='heading'>
+hilbish.editor.getVimRegister(register) -> string
+<a href="#editor.getVimRegister" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### getVimRegister(register) -> string
 Returns the text that is at the register.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='editor.insert'>
+<h4 class='heading'>
+hilbish.editor.insert(text)
+<a href="#editor.insert" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### insert(text)
 Inserts text into the line.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='editor.getChar'>
+<h4 class='heading'>
+hilbish.editor.getChar() -> string
+<a href="#editor.getChar" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
+Reads a keystroke from the user. This is in a format
+of something like Ctrl-L..
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='editor.setVimRegister'>
+<h4 class='heading'>
+hilbish.editor.setVimRegister(register, text)
+<a href="#editor.setVimRegister" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### setVimRegister(register, text)
 Sets the vim register at `register` to hold the passed text.
+#### Parameters
+This function has no parameters.  
+</div>
 

docs/api/hilbish/hilbish.history.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.history
+title: Module hilbish.history
 description: command history
 layout: doc
 menu:
@@ -13,18 +13,76 @@ This includes the ability to override functions to change the main
 method of saving history.
 
 ## Functions
-### add(cmd)
+|||
+|----|----|
+|<a href="#history.add">add(cmd)</a>|Adds a command to the history.|
+|<a href="#history.all">all() -> table</a>|Retrieves all history.|
+|<a href="#history.clear">clear()</a>|Deletes all commands from the history.|
+|<a href="#history.get">get(idx)</a>|Retrieves a command from the history based on the `idx`.|
+|<a href="#history.size">size() -> number</a>|Returns the amount of commands in the history.|
+
+<hr><div id='history.add'>
+<h4 class='heading'>
+hilbish.history.add(cmd)
+<a href="#history.add" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Adds a command to the history.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='history.all'>
+<h4 class='heading'>
+hilbish.history.all() -> table
+<a href="#history.all" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### all() -> table
 Retrieves all history.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='history.clear'>
+<h4 class='heading'>
+hilbish.history.clear()
+<a href="#history.clear" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### clear()
 Deletes all commands from the history.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='history.get'>
+<h4 class='heading'>
+hilbish.history.get(idx)
+<a href="#history.get" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### get(idx)
 Retrieves a command from the history based on the `idx`.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='history.size'>
+<h4 class='heading'>
+hilbish.history.size() -> number
+<a href="#history.size" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### size() -> number
 Returns the amount of commands in the history.
+#### Parameters
+This function has no parameters.  
+</div>
 

docs/api/hilbish/hilbish.jobs.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.jobs
+title: Module hilbish.jobs
 description: background job management
 layout: doc
 menu:
@@ -15,32 +15,95 @@ Jobs are the name of background tasks/commands. A job can be started via
 interactive usage or with the functions defined below for use in external runners.
 
 ## Functions
-### add(cmdstr, args, execPath)
+|||
+|----|----|
+|<a href="#jobs.add">add(cmdstr, args, execPath)</a>|Adds a new job to the job table. Note that this does not immediately run it.|
+|<a href="#jobs.all">all() -> table<@Job></a>|Returns a table of all job objects.|
+|<a href="#jobs.disown">disown(id)</a>|Disowns a job. This deletes it from the job table.|
+|<a href="#jobs.get">get(id) -> @Job</a>|Get a job object via its ID.|
+|<a href="#jobs.last">last() -> @Job</a>|Returns the last added job from the table.|
+
+<hr><div id='jobs.add'>
+<h4 class='heading'>
+hilbish.jobs.add(cmdstr, args, execPath)
+<a href="#jobs.add" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Adds a new job to the job table. Note that this does not immediately run it.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='jobs.all'>
+<h4 class='heading'>
+hilbish.jobs.all() -> table\<<a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" style="text-decoration: none;" id="lol">Job</a>>
+<a href="#jobs.all" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### all() -> table\<<a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" style="text-decoration: none;">Job</a>>
 Returns a table of all job objects.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='jobs.disown'>
+<h4 class='heading'>
+hilbish.jobs.disown(id)
+<a href="#jobs.disown" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### disown(id)
 Disowns a job. This deletes it from the job table.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='jobs.get'>
+<h4 class='heading'>
+hilbish.jobs.get(id) -> <a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" style="text-decoration: none;" id="lol">Job</a>
+<a href="#jobs.get" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### get(id) -> <a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" style="text-decoration: none;">Job</a>
 Get a job object via its ID.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='jobs.last'>
+<h4 class='heading'>
+hilbish.jobs.last() -> <a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" style="text-decoration: none;" id="lol">Job</a>
+<a href="#jobs.last" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### last() -> <a href="/Hilbish/docs/api/hilbish/hilbish.jobs/#job" style="text-decoration: none;">Job</a>
 Returns the last added job from the table.
+#### Parameters
+This function has no parameters.  
+</div>
 
 ## Types
+<hr>
+
 ## Job
 The Job type describes a Hilbish job.
-### Properties
-- `cmd`: The user entered command string for the job.
-- `running`: Whether the job is running or not.
-- `id`: The ID of the job in the job table
-- `pid`: The Process ID
-- `exitCode`: The last exit code of the job.
-- `stdout`: The standard output of the job. This just means the normal logs of the process.
-- `stderr`: The standard error stream of the process. This (usually) includes error messages of the job.
+## Object properties
+|||
+|----|----|
+|cmd|The user entered command string for the job.|
+|running|Whether the job is running or not.|
+|id|The ID of the job in the job table|
+|pid|The Process ID|
+|exitCode|The last exit code of the job.|
+|stdout|The standard output of the job. This just means the normal logs of the process.|
+|stderr|The standard error stream of the process. This (usually) includes error messages of the job.|
+
 
 ### Methods
 #### background()

docs/api/hilbish/hilbish.module.md

@@ -0,0 +1,69 @@
+---
+title: Module hilbish.module
+description: native module loading
+layout: doc
+menu:
+  docs:
+    parent: "API"
+---
+
+## Introduction
+
+The hilbish.module interface provides a function to load
+Hilbish plugins/modules. Hilbish modules are Go-written
+plugins (see https://pkg.go.dev/plugin) that are used to add functionality
+to Hilbish that cannot be written in Lua for any reason.
+
+Note that you don't ever need to use the load function that is here as
+modules can be loaded with a `require` call like Lua C modules, and the
+search paths can be changed with the `paths` property here.
+
+To make a valid native module, the Go plugin has to export a Loader function
+with a signature like so: `func(*rt.Runtime) rt.Value`.
+
+`rt` in this case refers to the Runtime type at
+https://pkg.go.dev/github.com/arnodel/golua@master/runtime#Runtime
+
+Hilbish uses this package as its Lua runtime. You will need to read
+it to use it for a native plugin.
+
+Here is some code for an example plugin:
+```go
+package main
+
+import (
+	rt "github.com/arnodel/golua/runtime"
+)
+
+func Loader(rtm *rt.Runtime) rt.Value {
+	return rt.StringValue("hello world!")
+}
+```
+
+This can be compiled with `go build -buildmode=plugin plugin.go`.
+If you attempt to require and print the result (`print(require 'plugin')`), it will show "hello world!"
+
+## Functions
+|||
+|----|----|
+|<a href="#module.load">load(path)</a>|Loads a module at the designated `path`.|
+
+## Static module fields
+|||
+|----|----|
+|paths|A list of paths to search when loading native modules. This is in the style of Lua search paths and will be used when requiring native modules. Example: `?.so;?/?.so`|
+
+<hr><div id='module.load'>
+<h4 class='heading'>
+hilbish.module.load(path)
+<a href="#module.load" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
+Loads a module at the designated `path`.
+It will throw if any error occurs.
+#### Parameters
+This function has no parameters.  
+</div>
+

docs/api/hilbish/hilbish.os.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.os
+title: Module hilbish.os
 description: OS Info
 layout: doc
 menu:
@@ -12,8 +12,10 @@ The `os` interface provides simple text information properties about
 the current OS on the systen. This mainly includes the name and
 version.
 
-## Interface fields
-- `family`: Family name of the current OS
-- `name`: Pretty name of the current OS
-- `version`: Version of the current OS
+## Static module fields
+|||
+|----|----|
+|family|Family name of the current OS|
+|name|Pretty name of the current OS|
+|version|Version of the current OS|
 

docs/api/hilbish/hilbish.runner.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.runner
+title: Module hilbish.runner
 description: interactive command runner customization
 layout: doc
 menu:
@@ -15,17 +15,53 @@ language or script of their choosing. A good example is using it to
 write command in Fennel.
 
 ## Functions
-### setMode(cb)
+|||
+|----|----|
+|<a href="#runner.setMode">setMode(cb)</a>|This is the same as the `hilbish.runnerMode` function. It takes a callback,|
+|<a href="#runner.lua">lua(cmd)</a>|Evaluates `cmd` as Lua input. This is the same as using `dofile`|
+|<a href="#runner.sh">sh(cmd)</a>|Runs a command in Hilbish's shell script interpreter.|
+
+<hr><div id='runner.setMode'>
+<h4 class='heading'>
+hilbish.runner.setMode(cb)
+<a href="#runner.setMode" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 This is the same as the `hilbish.runnerMode` function. It takes a callback,
 which will be used to execute all interactive input.
 In normal cases, neither callbacks should be overrided by the user,
 as the higher level functions listed below this will handle it.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='runner.lua'>
+<h4 class='heading'>
+hilbish.runner.lua(cmd)
+<a href="#runner.lua" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### lua(cmd)
 Evaluates `cmd` as Lua input. This is the same as using `dofile`
 or `load`, but is appropriated for the runner interface.
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='runner.sh'>
+<h4 class='heading'>
+hilbish.runner.sh(cmd)
+<a href="#runner.sh" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### sh(cmd)
 Runs a command in Hilbish's shell script interpreter.
 This is the equivalent of using `source`.
+#### Parameters
+This function has no parameters.  
+</div>
 

docs/api/hilbish/hilbish.timers.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.timers
+title: Module hilbish.timers
 description: timeout and interval API
 layout: doc
 menu:
@@ -30,25 +30,57 @@ t:start()
 print(t.running) // true
 ```
 
-## Interface fields
-- `INTERVAL`: Constant for an interval timer type
-- `TIMEOUT`: Constant for a timeout timer type
-
 ## Functions
-### create(type, time, callback) -> <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" style="text-decoration: none;">Timer</a>
+|||
+|----|----|
+|<a href="#timers.create">create(type, time, callback) -> @Timer</a>|Creates a timer that runs based on the specified `time` in milliseconds.|
+|<a href="#timers.get">get(id) -> @Timer</a>|Retrieves a timer via its ID.|
+
+## Static module fields
+|||
+|----|----|
+|INTERVAL|Constant for an interval timer type|
+|TIMEOUT|Constant for a timeout timer type|
+
+<hr><div id='timers.create'>
+<h4 class='heading'>
+hilbish.timers.create(type, time, callback) -> <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" style="text-decoration: none;" id="lol">Timer</a>
+<a href="#timers.create" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Creates a timer that runs based on the specified `time` in milliseconds.
 The `type` can either be `hilbish.timers.INTERVAL` or `hilbish.timers.TIMEOUT`
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='timers.get'>
+<h4 class='heading'>
+hilbish.timers.get(id) -> <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" style="text-decoration: none;" id="lol">Timer</a>
+<a href="#timers.get" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### get(id) -> <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" style="text-decoration: none;">Timer</a>
 Retrieves a timer via its ID.
+#### Parameters
+This function has no parameters.  
+</div>
 
 ## Types
+<hr>
+
 ## Timer
 The Job type describes a Hilbish timer.
-### Properties
-- `type`: What type of timer it is
-- `running`: If the timer is running
-- `duration`: The duration in milliseconds that the timer will run
+## Object properties
+|||
+|----|----|
+|type|What type of timer it is|
+|running|If the timer is running|
+|duration|The duration in milliseconds that the timer will run|
+
 
 ### Methods
 #### start()

docs/api/hilbish/hilbish.userDir.md

@@ -1,5 +1,5 @@
 ---
-title: Interface hilbish.userDir
+title: Module hilbish.userDir
 description: user-related directories
 layout: doc
 menu:
@@ -12,7 +12,9 @@ This interface just contains properties to know about certain user directories.
 It is equivalent to XDG on Linux and gets the user's preferred directories
 for configs and data.
 
-## Interface fields
-- `config`: The user's config directory
-- `data`: The user's directory for program data
+## Static module fields
+|||
+|----|----|
+|config|The user's config directory|
+|data|The user's directory for program data|
 

docs/api/terminal.md

@@ -11,16 +11,63 @@ menu:
 The terminal library is a simple and lower level library for certain terminal interactions.
 
 ## Functions
-### restoreState()
+|||
+|----|----|
+|<a href="#restoreState">restoreState()</a>|Restores the last saved state of the terminal|
+|<a href="#saveState">saveState()</a>|Saves the current state of the terminal|
+|<a href="#setRaw">setRaw()</a>|Puts the terminal in raw mode|
+|<a href="#size">size()</a>|Gets the dimensions of the terminal. Returns a table with `width` and `height`|
+
+<hr><div id='restoreState'>
+<h4 class='heading'>
+terminal.restoreState()
+<a href="#restoreState" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
+
 Restores the last saved state of the terminal
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='saveState'>
+<h4 class='heading'>
+terminal.saveState()
+<a href="#saveState" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### saveState()
 Saves the current state of the terminal
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='setRaw'>
+<h4 class='heading'>
+terminal.setRaw()
+<a href="#setRaw" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### setRaw()
 Puts the terminal in raw mode
+#### Parameters
+This function has no parameters.  
+</div>
+
+<hr><div id='size'>
+<h4 class='heading'>
+terminal.size()
+<a href="#size" class='heading-link'>
+	<i class="fas fa-paperclip"></i>
+</a>
+</h4>
 
-### size()
 Gets the dimensions of the terminal. Returns a table with `width` and `height`
 Note: this is not the size in relation to the dimensions of the display
+#### Parameters
+This function has no parameters.  
+</div>
 

docs/faq.md

@@ -15,11 +15,12 @@ It compiles for Windows (CI ensures it does), but otherwise it is not
 directly supported. If you'd like to improve this situation,
 checkout [the discussion](https://github.com/Rosettea/Hilbish/discussions/165).
 
-# Where is the API documentation?
-The builtin `doc` command supplies all documentation of Hilbish provided
-APIs. You can also check the sidebar.
-
 # Why?
 Hilbish emerged from the desire of a Lua configured shell.
 It was the initial reason that it was created, but now it's more:
 to be hyper extensible, simpler and more user friendly.
+
+# Does it have "autocompletion" or "tab completion"
+Of course! This is a modern shell. Hilbish provides a way for users
+to write tab completion for any command and/or the whole shell.
+Inline hinting and syntax highlighting are also available.

docs/hooks/_index.md

@@ -1,10 +1,19 @@
+---
+title: Hooks
+description:
+layout: doc
+weight: -50
+menu:
+  docs
+---
+
 Here is a list of bait hooks that are thrown by Hilbish. If a hook is related
 to a command, it will have the `command` scope, as example.
 
 Here is the format for a doc for a hook:
-+ <hook name> -> <args> > <description>
++ {hook name} -> args > description
 
-`<args>` just means the arguments of the hook. If a hook doc has the format
+`{args}` just means the arguments of the hook. If a hook doc has the format
 of `arg...`, it means the hook can take/recieve any number of `arg`.
 
 + error -> eventName, handler, err > Emitted when there is an error in

docs/hooks/command.md

@@ -1,12 +1,21 @@
-+ `command.preexec` -> input, cmdStr > Thrown before a command
+---
+title: Command
+description:
+layout: doc
+menu:
+  docs:
+    parent: "Hooks"
+---
+
+- `command.preexec` -> input, cmdStr > Thrown before a command
 is executed. The `input` is the user written command, while `cmdStr`
 is what will be executed (`input` will have aliases while `cmdStr`
 will have alias resolved input).
 
-+ `command.exit` -> code, cmdStr > Thrown when a command exits.
+- `command.exit` -> code, cmdStr > Thrown when a command exits.
 `code` is the exit code of the command, and `cmdStr` is the command that was run.
 
-+ `command.not-found` -> cmdStr > Thrown when a command is not found.
+- `command.not-found` -> cmdStr > Thrown when a command is not found.
 
-+ `command.not-executable` -> cmdStr > Thrown when Hilbish attempts to run a file
+- `command.not-executable` -> cmdStr > Thrown when Hilbish attempts to run a file
 that is not executable.

docs/hooks/hilbish.md

@@ -1,3 +1,12 @@
+---
+title: Hilbish
+description:
+layout: doc
+menu:
+  docs:
+    parent: "Hooks"
+---
+
 + `hilbish.exit` > Sent when Hilbish is about to exit.
 
 + `hilbish.vimMode` -> modeName > Sent when Hilbish's Vim mode is changed (example insert to normal mode),

docs/hooks/signal.md

@@ -1,3 +1,12 @@
+---
+title: Signal
+description:
+layout: doc
+menu:
+  docs:
+    parent: "Hooks"
+---
+
 + `signal.sigint` > Sent when Hilbish receives SIGINT (on Ctrl-C).
 
 + `signal.resize` > Sent when the terminal is resized.

editor.go

@@ -16,6 +16,7 @@ func editorLoader(rtm *rt.Runtime) *rt.Table {
 		"setVimRegister": {editorSetRegister, 1, false},
 		"getVimRegister": {editorGetRegister, 2, false},
 		"getLine": {editorGetLine, 0, false},
+		"readChar": {editorReadChar, 0, false},
 	}
 
 	mod := rt.NewTable()
@@ -94,3 +95,13 @@ func editorGetLine(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 
 	return c.PushingNext1(t.Runtime, rt.StringValue(string(buf))), nil
 }
+
+// #interface editor
+// getChar() -> string
+// Reads a keystroke from the user. This is in a format
+// of something like Ctrl-L..
+func editorReadChar(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
+	buf := lr.rl.ReadChar()
+
+	return c.PushingNext1(t.Runtime, rt.StringValue(string(buf))), nil
+}

emmyLuaDocs/bait.lua

@@ -3,8 +3,6 @@
 local bait = {}
 
 --- Catches a hook with `name`. Runs the `cb` when it is thrown
---- @param name string
---- @param cb function
 function bait.catch(name, cb) end
 
 --- Same as catch, but only runs the `cb` once and then removes the hook

emmyLuaDocs/hilbish.lua

@@ -40,6 +40,10 @@ function hilbish.editor.getVimRegister(register) end
 --- Inserts text into the line.
 function hilbish.editor.insert(text) end
 
+--- Reads a keystroke from the user. This is in a format
+--- of something like Ctrl-L..
+function hilbish.editor.getChar() end
+
 --- Sets the vim register at `register` to hold the passed text.
 --- @param register string
 --- @param text string
@@ -196,10 +200,14 @@ function hilbish:autoFlush(auto) end
 --- Flush writes all buffered input to the sink.
 function hilbish:flush() end
 
---- Reads input from the sink.
+--- Reads a liine of input from the sink.
 --- @returns string
 function hilbish:read() end
 
+--- Reads all input from the sink.
+--- @returns string
+function hilbish:readAll() end
+
 --- Writes data to a sink.
 function hilbish:write(str) end
 
@@ -212,6 +220,10 @@ function hilbish.jobs:start() end
 --- Stops the job from running.
 function hilbish.jobs:stop() end
 
+--- Loads a module at the designated `path`.
+--- It will throw if any error occurs.
+function hilbish.module.load(path) end
+
 --- Runs a command in Hilbish's shell script interpreter.
 --- This is the equivalent of using `source`.
 --- @param cmd string

go.mod

@@ -4,8 +4,8 @@ go 1.17
 
 require (
 	github.com/arnodel/golua v0.0.0-20220221163911-dfcf252b6f86
+	github.com/atsushinee/go-markdown-generator v0.0.0-20191121114853-83f9e1f68504
 	github.com/blackfireio/osinfo v1.0.3
-	github.com/chuckpreslar/emission v0.0.0-20170206194824-a7ddd980baf9
 	github.com/maxlandon/readline v0.1.0-beta.0.20211027085530-2b76cabb8036
 	github.com/pborman/getopt v1.1.0
 	github.com/sahilm/fuzzy v0.1.0
@@ -18,6 +18,7 @@ require (
 	github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d // indirect
 	github.com/arnodel/strftime v0.1.6 // indirect
 	github.com/evilsocket/islazy v1.10.6 // indirect
+	github.com/kylelemons/godebug v1.1.0 // indirect
 	github.com/olekukonko/ts v0.0.0-20171002115256-78ecb04241c0 // indirect
 	github.com/rivo/uniseg v0.2.0 // indirect
 	golang.org/x/sync v0.0.0-20220513210516-0976fa681c29 // indirect

go.sum

@@ -1,13 +1,5 @@
-github.com/Rosettea/golua v0.0.0-20220419183026-6d22d6fec5ac h1:dtXrgjch8PQyf7C90anZUquB5U3dr8AcMGJofeuirrI=
-github.com/Rosettea/golua v0.0.0-20220419183026-6d22d6fec5ac/go.mod h1:9jzpYPiU2is0HVGCiuIOBSXdergHUW44IEjmuN1UrIE=
-github.com/Rosettea/golua v0.0.0-20220518005949-116371948fe3 h1:I/wWr40FFLFF9pbT3wLb1FAEZhKb/hUWE+nJ5uHBK2g=
-github.com/Rosettea/golua v0.0.0-20220518005949-116371948fe3/go.mod h1:9jzpYPiU2is0HVGCiuIOBSXdergHUW44IEjmuN1UrIE=
-github.com/Rosettea/golua v0.0.0-20220621002945-b05143999437 h1:6lWu4YVLeKuZ8jR9xwHONhkHBsrIbw5dpfG1gtOVw0A=
-github.com/Rosettea/golua v0.0.0-20220621002945-b05143999437/go.mod h1:9jzpYPiU2is0HVGCiuIOBSXdergHUW44IEjmuN1UrIE=
 github.com/Rosettea/golua v0.0.0-20221213193027-cbf6d4e4d345 h1:QNYjYDogUSiNUkffbhFSrSCtpZhofeiVYGFN2FI4wSs=
 github.com/Rosettea/golua v0.0.0-20221213193027-cbf6d4e4d345/go.mod h1:9jzpYPiU2is0HVGCiuIOBSXdergHUW44IEjmuN1UrIE=
-github.com/Rosettea/sh/v3 v3.4.0-0.dev.0.20220306140409-795a84b00b4e h1:P2XupP8SaylWaudD1DqbWtZ3mIa8OsE9635LmR+Q+lg=
-github.com/Rosettea/sh/v3 v3.4.0-0.dev.0.20220306140409-795a84b00b4e/go.mod h1:R09vh/04ILvP2Gj8/Z9Jd0Dh0ZIvaucowMEs6abQpWs=
 github.com/Rosettea/sh/v3 v3.4.0-0.dev.0.20220524215627-dfd9a4fa219b h1:s5eDMhBk6H1BgipgLub/gv9qeyBaTuiHM0k3h2/9TSE=
 github.com/Rosettea/sh/v3 v3.4.0-0.dev.0.20220524215627-dfd9a4fa219b/go.mod h1:R09vh/04ILvP2Gj8/Z9Jd0Dh0ZIvaucowMEs6abQpWs=
 github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d h1:licZJFw2RwpHMqeKTCYkitsPqHNxTmd4SNR5r94FGM8=
@@ -16,10 +8,10 @@ github.com/arnodel/edit v0.0.0-20220202110212-dfc8d7a13890/go.mod h1:AcpttpuZBaL
 github.com/arnodel/strftime v0.1.6 h1:0hc0pUvk8KhEMXE+htyaOUV42zNcf/csIbjzEFCJqsw=
 github.com/arnodel/strftime v0.1.6/go.mod h1:5NbK5XqYK8QpRZpqKNt4OlxLtIB8cotkLk4KTKzJfWs=
 github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
+github.com/atsushinee/go-markdown-generator v0.0.0-20191121114853-83f9e1f68504 h1:R1/AOzdMbopSliUTTEHvHbyNmnZ3YxY5GvdhTkpPsSY=
+github.com/atsushinee/go-markdown-generator v0.0.0-20191121114853-83f9e1f68504/go.mod h1:kHBCvAXJIatTX1pw6tLiOspjGc3MhUDRlog9yrCUS+k=
 github.com/blackfireio/osinfo v1.0.3 h1:Yk2t2GTPjBcESv6nDSWZKO87bGMQgO+Hi9OoXPpxX8c=
 github.com/blackfireio/osinfo v1.0.3/go.mod h1:Pd987poVNmd5Wsx6PRPw4+w7kLlf9iJxoRKPtPAjOrA=
-github.com/chuckpreslar/emission v0.0.0-20170206194824-a7ddd980baf9 h1:xz6Nv3zcwO2Lila35hcb0QloCQsc38Al13RNEzWRpX4=
-github.com/chuckpreslar/emission v0.0.0-20170206194824-a7ddd980baf9/go.mod h1:2wSM9zJkl1UQEFZgSd68NfCgRz1VL1jzy/RjCg+ULrs=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/creack/pty v1.1.15 h1:cKRCLMj3Ddm54bKSpemfQ8AtYFBhAI2MPmdys22fBdc=
 github.com/creack/pty v1.1.15/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4=
@@ -36,6 +28,8 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
+github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
 github.com/lucasb-eyer/go-colorful v1.0.3/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
 github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
 github.com/olekukonko/ts v0.0.0-20171002115256-78ecb04241c0 h1:LiZB1h0GIcudcDci2bxbqI6DXV8bF8POAnArqvRrIyw=
@@ -51,7 +45,6 @@ github.com/rogpeppe/go-internal v1.8.1-0.20210923151022-86f73c517451 h1:d1PiN4Rx
 github.com/rogpeppe/go-internal v1.8.1-0.20210923151022-86f73c517451/go.mod h1:JeRgkft04UBgHMgCIwADu4Pn6Mtm5d4nPKWu0nJ5d+o=
 github.com/sahilm/fuzzy v0.1.0 h1:FzWGaw2Opqyu+794ZQ9SYifWv2EIXpwP4q8dY1kDAwI=
 github.com/sahilm/fuzzy v0.1.0/go.mod h1:VFvziUEIMCrT6A6tw2RFIXPXXmzXbOsSHF0DOI8ZK9Y=
-golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ=
 golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20220513210516-0976fa681c29 h1:w8s32wxx3sY+OjLlv9qltkLU5yvJzxjjgiHWLjdIcw4=
 golang.org/x/sync v0.0.0-20220513210516-0976fa681c29/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -60,18 +53,13 @@ golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210925032602-92d5a993a665/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220114195835-da31bd327af9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9 h1:nhht2DYV/Sn3qOayu8lM+cU1ii9sTLUeBQwQQfUHtrs=
-golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a h1:dGzPydgVsqGcTRVwiLJ1jVbufYwmzD3LfVPLKsKg+0k=
 golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210916214954-140adaaadfaf/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
-golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
-golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.0.0-20220411215600-e5f449aeb171 h1:EH1Deb8WZJ0xc0WK//leUHXcX9aLE5SymusoTmMZye8=
 golang.org/x/term v0.0.0-20220411215600-e5f449aeb171/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=

golibs/bait/bait.go

@@ -1,9 +1,28 @@
 // the event emitter
-// Bait is the event emitter for Hilbish. Why name it bait? Why not.
-// It throws hooks that you can catch. This is what you will use if
-// you want to listen in on hooks to know when certain things have
-// happened, like when you've changed directory, a command has failed,
-// etc. To find all available hooks thrown by Hilbish, see doc hooks.
+/*
+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.
+
+Examples of this are in the Hilbish default config!
+Consider this part of it:
+```lua
+bait.catch('command.exit', function(code)
+	running = false
+	doPrompt(code ~= 0)
+	doNotifyPrompt()
+end)
+```
+
+What this does is, whenever the `command.exit` event is thrown,
+this function will set the user prompt.
+*/
 package bait
 
 import (
@@ -229,6 +248,8 @@ func handleHook(t *rt.Thread, c *rt.GoCont, name string, catcher *rt.Closure, ar
 }
 
 // throw(name, ...args)
+// #param name string The name of the hook.
+// #param args ...any The arguments to pass to the hook.
 // Throws a hook with `name` with the provided `args`
 // --- @param name string
 // --- @vararg any
@@ -251,8 +272,8 @@ func (b *Bait) bthrow(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 
 // catch(name, cb)
 // Catches a hook with `name`. Runs the `cb` when it is thrown
-// --- @param name string
-// --- @param cb function
+// #param name string ummm
+// #param cb function ?
 func (b *Bait) bcatch(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	name, catcher, err := util.HandleStrCallback(t, c)
 	if err != nil {

golibs/commander/commander.go

@@ -22,7 +22,7 @@ The `sinks` parameter is a table with 3 keys: `in`, `out`,
 and `err`. The values of these is a @Sink.
 
 - `in` is the standard input. You can read from this sink
-to get user input. (**This is currently unimplemented.**)
+to get user input.
 - `out` is standard output. This is usually where text meant for
 output should go.
 - `err` is standard error. This sink is for writing errors, as the

module.go

@@ -0,0 +1,92 @@
+package main
+
+import (
+	"plugin"
+
+	"hilbish/util"
+
+	rt "github.com/arnodel/golua/runtime"
+)
+
+// #interface module
+// native module loading
+// #field paths A list of paths to search when loading native modules. This is in the style of Lua search paths and will be used when requiring native modules. Example: `?.so;?/?.so`
+/*
+The hilbish.module interface provides a function to load
+Hilbish plugins/modules. Hilbish modules are Go-written
+plugins (see https://pkg.go.dev/plugin) that are used to add functionality
+to Hilbish that cannot be written in Lua for any reason.
+
+Note that you don't ever need to use the load function that is here as
+modules can be loaded with a `require` call like Lua C modules, and the
+search paths can be changed with the `paths` property here.
+
+To make a valid native module, the Go plugin has to export a Loader function
+with a signature like so: `func(*rt.Runtime) rt.Value`.
+
+`rt` in this case refers to the Runtime type at
+https://pkg.go.dev/github.com/arnodel/golua@master/runtime#Runtime
+
+Hilbish uses this package as its Lua runtime. You will need to read
+it to use it for a native plugin.
+
+Here is some code for an example plugin:
+```go
+package main
+
+import (
+	rt "github.com/arnodel/golua/runtime"
+)
+
+func Loader(rtm *rt.Runtime) rt.Value {
+	return rt.StringValue("hello world!")
+}
+```
+
+This can be compiled with `go build -buildmode=plugin plugin.go`.
+If you attempt to require and print the result (`print(require 'plugin')`), it will show "hello world!"
+*/
+func moduleLoader(rtm *rt.Runtime) *rt.Table {
+	exports := map[string]util.LuaExport{
+		"load": {moduleLoad, 2, false},
+	}
+
+	mod := rt.NewTable()
+	util.SetExports(rtm, mod, exports)
+
+	return mod
+}
+
+// #interface module
+// load(path)
+// Loads a module at the designated `path`.
+// It will throw if any error occurs.
+func moduleLoad(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
+	if err := c.CheckNArgs(1); err != nil {
+		return nil, err
+	}
+	
+	path, err := c.StringArg(0)
+	if err != nil {
+		return nil, err
+	}
+
+	p, err := plugin.Open(path)
+	if err != nil {
+		return nil, err
+	}
+
+	value, err := p.Lookup("Loader")
+	if err != nil {
+		return nil, err
+	}
+
+	loader, ok := value.(func(*rt.Runtime) rt.Value)
+	if !ok {
+		return nil, nil
+	}
+
+	val := loader(t.Runtime)
+
+	return c.PushingNext1(t.Runtime, val), nil
+}

nature/commands/doc.lua

@@ -1,6 +1,9 @@
+local ansikit = require 'ansikit'
 local commander = require 'commander'
 local fs = require 'fs'
 local lunacolors = require 'lunacolors'
+local Greenhouse = require 'nature.greenhouse'
+local Page = require 'nature.greenhouse.page'
 
 commander.register('doc', function(args, sinks)
 	local moddocPath = hilbish.dataDir .. '/docs/'
@@ -9,11 +12,6 @@ commander.register('doc', function(args, sinks)
 		-- hilbish git
 		moddocPath = './docs/'
 	end
-	local apidocHeader = [[
-# %s
-{grayBg}  {white}{italic}%s  {reset}
-
-]]
 
 	local modules = table.map(fs.readdir(moddocPath), function(f)
 		return lunacolors.underline(lunacolors.blue(string.gsub(f, '.md', '')))
@@ -25,47 +23,15 @@ to Hilbish.
 
 Usage: doc <section> [subdoc]
 Available sections: ]] .. table.concat(modules, ', ')
-	if #args > 0 then
-		local mod = args[1]
-
-		local f = io.open(moddocPath .. mod .. '.md', 'rb')
-		local funcdocs = nil
-		local subdocName = args[2]
-		if not f then
-			-- assume subdir
-			-- dataDir/docs/<mod>/<mod>.md
-			moddocPath = moddocPath .. mod .. '/'
-			if not subdocName then
-				subdocName = '_index'
-			end
-			f = io.open(moddocPath .. subdocName .. '.md', 'rb')
-			if not f then
-				f = io.open(moddocPath .. subdocName:match '%w+' .. '/' .. subdocName .. '.md', 'rb')
-			end
-			if not f then
-				moddocPath = moddocPath .. subdocName .. '/'
-				subdocName = args[3] or '_index'
-				f = io.open(moddocPath .. subdocName .. '.md', 'rb')
-			end
-			if not f then
-				sinks.out:writeln('No documentation found for ' .. mod .. '.')
-				return 1
-			end
-		end
-		funcdocs = f:read '*a':gsub('-([%d]+)', '%1')
-		local moddocs = table.filter(fs.readdir(moddocPath), function(f) return f ~= '_index.md' and f ~= 'index.md' end)
-		local subdocs = table.map(moddocs, function(fname)
-			return lunacolors.underline(lunacolors.blue(string.gsub(fname, '.md', '')))
-		end)
-		if #moddocs ~= 0 then
-			funcdocs = funcdocs .. '\nSubdocs: ' .. table.concat(subdocs, ', ')
-		end
-
-		local valsStr = funcdocs:match '%-%-%-\n([^%-%-%-]+)\n'
+	local f
+	local function handleYamlInfo(d)
 		local vals = {}
+		local docs = d
+
+		local valsStr = docs:match '%-%-%-\n([^%-%-%-]+)\n'
+		print(valsStr)
 		if valsStr then
-			local _, endpos = funcdocs:find('---\n' .. valsStr .. '\n---\n\n', 1, true)
-			funcdocs = funcdocs:sub(endpos + 1, #funcdocs)
+			docs = docs:sub(valsStr:len() + 10, #docs)
 
 			-- parse vals
 			local lines = string.split(valsStr, '\n')
@@ -78,15 +44,78 @@ Available sections: ]] .. table.concat(modules, ', ')
 				end
 			end
 		end
-		if mod == 'api' then
-			funcdocs = string.format(apidocHeader, vals.title, vals.description or 'no description.') .. funcdocs
-		end
-		doc = funcdocs:sub(1, #funcdocs - 1)
-		f:close()
+
+		--docs = docs:sub(1, #docs - 1)
+		return docs, vals
 	end
 
+	if #args > 0 then
+		local mod = args[1]
+
+		f = io.open(moddocPath .. mod .. '.md', 'rb')
+		local funcdocs = nil
+		local subdocName = args[2]
+		if not f then
+			moddocPath = moddocPath .. mod .. '/'
+			if not subdocName then
+				subdocName = '_index'
+			end
+			f = io.open(moddocPath .. subdocName .. '.md', 'rb')
+			local oldmoddocPath = moddocPath
+			if not f then
+				moddocPath = moddocPath .. subdocName:match '%w+' .. '/'
+				f = io.open(moddocPath .. subdocName .. '.md', 'rb')
+			end
+			if not f then
+				moddocPath = oldmoddocPath .. subdocName .. '/'
+				subdocName = args[3] or '_index'
+				f = io.open(moddocPath .. subdocName .. '.md', 'rb')
+			end
+			if not f then
+				sinks.out:writeln('No documentation found for ' .. mod .. '.')
+				return 1
+			end
+		end
+
+	end
+
+	local moddocs = table.filter(fs.readdir(moddocPath), function(f) return f ~= '_index.md' and f ~= 'index.md' end)
+	local subdocs = table.map(moddocs, function(fname)
+		return lunacolors.underline(lunacolors.blue(string.gsub(fname, '.md', '')))
+	end)
+
+	local gh = Greenhouse(sinks.out)
+	function gh:resize()
+		local size = terminal.size()
+		self.region = {
+			width = size.width,
+			height = size.height - 2
+		}
+	end
+	gh:resize()
+
+	function gh:render()
+		local workingPage = self.pages[self.curPage]
+		local offset = self.offset
+		if self.isSpecial then
+			offset = self.specialOffset
+			workingPage = self.specialPage
+		end
+
+		self.sink:write(ansikit.getCSI(self.region.height + 1 .. ';1', 'H'))
+		self.sink:write(ansikit.getCSI(0, 'J'))
+		if not self.isSpecial then
+			if args[1] == 'api' then
+				self.sink:writeln(lunacolors.reset(string.format('%s', workingPage.title)))
+				self.sink:write(lunacolors.format(string.format('{grayBg} ↳ {white}{italic}%s {reset}', workingPage.description or 'No description.')))
+			else
+				self.sink:write(lunacolors.reset(string.format('Viewing doc page %s', moddocPath)))
+			end
+		end
+	end
 	local backtickOccurence = 0
-	sinks.out:writeln(lunacolors.format(doc:gsub('`', function()
+	local function formatDocText(d)
+		return lunacolors.format(d:gsub('`', function()
 			backtickOccurence = backtickOccurence + 1
 			if backtickOccurence % 2 == 0 then
 				return '{reset}'
@@ -96,5 +125,33 @@ Available sections: ]] .. table.concat(modules, ', ')
 		end):gsub('\n#+.-\n', function(t)
 			local signature = t:gsub('<.->(.-)</.->', '{underline}%1'):gsub('\\', '<')
 			return '{bold}{yellow}' .. signature .. '{reset}'
-	end)))
+		end))
+	end
+
+
+	local doc, vals = handleYamlInfo(#args == 0 and doc or formatDocText(f:read '*a':gsub('-([%d]+)', '%1')))
+	if #moddocs ~= 0 and f then
+		doc = doc .. '\nSubdocs: ' .. table.concat(subdocs, ', ') .. '\n\n'
+	end
+	if f then f:close() end
+
+	local page = Page(vals.title, doc)
+	page.description = vals.description
+	gh:addPage(page)
+
+	-- add subdoc pages
+	for _, sdName in ipairs(moddocs) do
+		local sdFile = fs.join(sdName, '_index.md')
+		if sdName:match '.md$' then
+			sdFile = sdName
+		end
+
+		local f = io.open(moddocPath .. sdFile, 'rb')
+		local doc, vals = handleYamlInfo(f:read '*a':gsub('-([%d]+)', '%1'))
+		local page = Page(vals.title, formatDocText(doc))
+		page.description = vals.description
+		gh:addPage(page)
+	end
+	ansikit.hideCursor()
+	gh:initUi()
 end)

nature/commands/greenhouse.lua

@@ -0,0 +1,124 @@
+local ansikit = require 'ansikit'
+local bait = require 'bait'
+local commander = require 'commander'
+local hilbish = require 'hilbish'
+local lunacolors = require 'lunacolors'
+local terminal = require 'terminal'
+local Greenhouse = require 'nature.greenhouse'
+local Page = require 'nature.greenhouse.page'
+
+commander.register('greenhouse', function(args, sinks)
+	local gh = Greenhouse(sinks.out)
+
+	local buffer = ''
+	local display = ''
+	local command = false
+	local commands = {
+		q = function()
+			gh.keybinds['Ctrl-D'](gh)
+		end,
+		['goto'] = function(args)
+			if not args[1] then
+				return 'nuh uh'
+			end
+			gh:jump(tonumber(args[1]))
+		end
+	}
+
+	function gh:resize()
+		local size = terminal.size()
+		self.region = {
+			width = size.width,
+			height = size.height - 2
+		}
+	end
+
+	function gh:render()
+		local workingPage = self.pages[self.curPage]
+		local offset = self.offset
+		if self.isSpecial then
+			offset = self.specialOffset
+			workingPage = self.specialPage
+		end
+
+		self.sink:write(ansikit.getCSI(self.region.height + 1 .. ';1', 'H'))
+		if not self.isSpecial then
+			self.sink:writeln(lunacolors.format(string.format('{grayBg} ↳ Page %d%s{reset}', self.curPage, workingPage.title and ' — ' .. workingPage.title .. ' ' or '')))
+		end
+		self.sink:write(buffer == '' and display or buffer)
+	end
+	function gh:input(c)
+		-- command handling
+		if c == ':' and not command then
+			command = true
+		end
+		if c == 'Escape' then
+			if command then
+				command = false
+				buffer = ''
+			else
+				if self.isSpecial then gh:special() end
+			end
+		elseif c == 'Backspace' then
+			buffer = buffer:sub(0, -2)
+			if buffer == '' then
+				command = false
+			else
+				goto update
+			end
+		end
+
+		if command then
+			ansikit.showCursor()
+			if buffer:match '^:' then buffer = buffer .. c else buffer = c end
+		else
+			ansikit.hideCursor()
+		end
+
+		::update::
+		gh:update()
+	end
+	gh:resize()
+
+	gh:keybind('Enter', function(self)
+		if self.isSpecial then
+			self:jump(self.specialPageIdx)
+			self:special(false)
+		else
+			if buffer:len() < 2 then return end
+
+			local splitBuf = string.split(buffer, " ")
+			local command = commands[splitBuf[1]:sub(2)]
+			if command then
+				table.remove(splitBuf, 1)
+				buffer = command(splitBuf) or ''
+			end
+			self:update()
+		end
+	end)
+
+	if sinks['in'].pipe then
+		local page = Page('stdin', sinks['in']:readAll())
+		gh:addPage(page)
+	end
+
+	for _, name in ipairs(args) do
+		local f <close> = io.open(name, 'r')
+		if not f then
+			sinks.err:writeln(string.format('could not open file %s', name))
+		end
+		local page = Page(name, f:read '*a')
+		gh:addPage(page)
+	end
+
+	if #gh.pages == 0 then
+		sinks.out:writeln [[greenhouse is the Hilbish pager library and command!
+usage: greenhouse <file>...
+
+example: greenhouse hello.md]]
+		return 1
+	end
+
+	ansikit.hideCursor()
+	gh:initUi()
+end)

nature/greenhouse/init.lua

@@ -0,0 +1,328 @@
+-- Greenhouse is a simple text scrolling handler for terminal programs.
+-- The idea is that it can be set a region to do its scrolling and paging
+-- job and then the user can draw whatever outside it.
+-- This reduces code duplication for the message viewer
+-- and flowerbook.
+
+local ansikit = require 'ansikit'
+local lunacolors = require 'lunacolors'
+local terminal = require 'terminal'
+local Page = require 'nature.greenhouse.page'
+local Object = require 'nature.object'
+
+local Greenhouse = Object:extend()
+
+function Greenhouse:new(sink)
+	local size = terminal.size()
+	self.region = size
+	self.contents = nil -- or can be a table
+	self.start = 1 -- where to start drawing from (should replace with self.region.y)
+	self.offset = 1 -- vertical text offset
+	self.sink = sink
+	self.pages = {}
+	self.curPage = 1
+	self.keybinds = {
+		['Up'] = function(self) self:scroll 'up' end,
+		['Down'] = function(self) self:scroll 'down' end,
+		['Ctrl-Left'] = self.previous,
+		['Ctrl-Right'] = self.next,
+		['Ctrl-N'] = function(self) self:toc(true) end,
+		['Enter'] = function(self)
+			if self.isSpecial then
+				self:jump(self.specialPageIdx)
+				self:special(false)
+			end
+		end
+	}
+	self.isSpecial = false
+	self.specialPage = nil
+	self.specialPageIdx = 1
+	self.specialOffset = 1
+
+	return self
+end
+
+function Greenhouse:addPage(page)
+	table.insert(self.pages, page)
+end
+
+function Greenhouse:updateCurrentPage(text)
+	local page = self.pages[self.curPage]
+	page:setText(text)
+end
+
+local function sub(str, limit)
+	local overhead = 0
+	local function addOverhead(s)
+		overhead = overhead + string.len(s)
+	end
+
+	local s = str:gsub('\x1b%[%d+;%d+;%d+;%d+;%d+%w', addOverhead)
+     :gsub('\x1b%[%d+;%d+;%d+;%d+%w', addOverhead)
+     :gsub('\x1b%[%d+;%d+;%d+%w',addOverhead)
+     :gsub('\x1b%[%d+;%d+%w', addOverhead)
+     :gsub('\x1b%[%d+%w', addOverhead)
+
+	return s:sub(0, limit + overhead)
+end
+
+function Greenhouse:draw()
+	local workingPage = self.pages[self.curPage]
+	local offset = self.offset
+	if self.isSpecial then
+		offset = self.specialOffset
+		workingPage = self.specialPage
+	end
+
+	if workingPage.lazy and not workingPage.loaded then
+		workingPage.initialize()
+	end
+
+	local lines = workingPage.lines
+	self.sink:write(ansikit.getCSI(self.start .. ';1', 'H'))
+	self.sink:write(ansikit.getCSI(2, 'J'))
+
+	for i = offset, offset + self.region.height - 1 do
+		if i > #lines then break end
+
+		local writer = self.sink.writeln
+		if i == offset + self.region.height - 1 then writer = self.sink.write end
+
+		writer(self.sink, sub(lines[i]:gsub('\t', '        '), self.region.width))
+	end
+	self:render()
+end
+
+function Greenhouse:render()
+end
+
+function Greenhouse:scroll(direction)
+	if self.isSpecial then
+		if direction == 'down' then
+			self:next(true)
+		elseif direction == 'up' then
+			self:previous(true)
+		end
+		return
+	end
+
+	local lines = self.pages[self.curPage].lines
+
+	local oldOffset = self.offset
+	if direction == 'down' then
+		self.offset = math.min(self.offset + 1, math.max(1, #lines - self.region.height))
+	elseif direction == 'up' then
+		self.offset = math.max(self.offset - 1, 1)
+	end
+
+	if self.offset ~= oldOffset then self:draw() end
+end
+
+function Greenhouse:update()
+	self:resize()
+	if self.isSpecial then
+		self:updateSpecial()
+	end
+
+	self:draw()
+end
+
+
+function Greenhouse:special(val)
+	self.isSpecial = val
+	self:update()
+end
+
+function Greenhouse:toggleSpecial()
+	self:special(not self.isSpecial)
+end
+
+--- This function will be called when the special page
+--- is on and needs to be updated.
+function Greenhouse:updateSpecial()
+end
+
+function Greenhouse:contents()
+end
+
+function Greenhouse:toc(toggle)
+	if not self.isSpecial then
+		self.specialPageIdx = self.curPage
+	end
+	if toggle then self.isSpecial = not self.isSpecial end
+	-- Generate a special page for our table of contents
+	local tocText = string.format([[
+%s
+
+]], lunacolors.cyan(lunacolors.bold '―― Table of Contents ――'))
+
+	local genericPageCount = 1
+	local contents = self:contents()
+	if contents then
+		for i, c in ipairs(contents) do
+			local title = c.title
+			if c.active then
+				title = lunacolors.invert(title)
+			end
+
+			tocText = tocText .. title .. '\n'
+		end
+	else
+		for i, page in ipairs(self.pages) do
+			local title = page.title
+			if title == 'Page' then
+				title = 'Page #' .. genericPageCount
+				genericPageCount = genericPageCount + 1
+			end
+			if i == self.specialPageIdx then
+				title = lunacolors.invert(title)
+			end
+
+			tocText = tocText .. title .. '\n'
+		end
+	end
+	self.specialPage = Page('TOC', tocText)
+	function self:updateSpecial()
+		self:toc()
+	end
+	self:draw()
+end
+
+function Greenhouse:resize()
+	local size = terminal.size()
+	self.region = size
+end
+
+function Greenhouse:next(special)
+	local oldCurrent = special and self.specialPageIdx or self.curPage
+	local pageIdx = math.min(oldCurrent + 1, #self.pages)
+
+	if special then
+		self.specialPageIdx = pageIdx
+	else
+		self.curPage = pageIdx
+	end
+
+	if pageIdx ~= oldCurrent then
+		self.offset = 1
+		self:update()
+	end
+end
+
+function Greenhouse:previous(special)
+	local oldCurrent = special and self.specialPageIdx or self.curPage
+	local pageIdx = math.max(self.curPage - 1, 1)
+
+	if special then
+		self.specialPageIdx = pageIdx
+	else
+		self.curPage = pageIdx
+	end
+
+	if pageIdx ~= oldCurrent then
+		self.offset = 1
+		self:update()
+	end
+end
+
+function Greenhouse:jump(idx)
+	if idx ~= self.curPage then
+		self.offset = 1
+	end
+	self.curPage = idx
+	self:update()
+end
+
+function Greenhouse:keybind(key, callback)
+	self.keybinds[key] = callback
+end
+
+function Greenhouse:input(char)
+end
+
+function Greenhouse:initUi()
+	local ansikit = require 'ansikit'
+	local bait = require 'bait'
+	local commander = require 'commander'
+	local hilbish = require 'hilbish'
+	local terminal = require 'terminal'
+	local Page = require 'nature.greenhouse.page'
+	local done = false
+
+	bait.catch('signal.sigint', function()
+		ansikit.clear()
+		done = true
+	end)
+
+	bait.catch('signal.resize', function()
+		self:update()
+	end)
+
+	ansikit.screenAlt()
+	ansikit.clear(true)
+	self:draw()
+
+	hilbish.goro(function()
+		while not done do
+			local c = read()
+			self:keybind('Ctrl-D', function()
+				done = true
+			end)
+
+			if self.keybinds[c] then
+				self.keybinds[c](self)
+			else
+				self:input(c)
+			end
+
+	--[[
+			if c == 27 then
+				local c1 = read()
+				if c1 == 91 then
+					local c2 = read()
+					if c2 == 66 then -- arrow down
+						self:scroll 'down'
+					elseif c2 == 65 then -- arrow up
+						self:scroll 'up'
+					end
+
+					if c2 == 49 then
+						local c3 = read()
+						if c3 == 59 then
+							local c4 = read()
+							if c4 == 53 then
+								local c5 = read()
+								if c5 == 67 then
+									self:next()
+								elseif c5 == 68 then
+									self:previous()
+								end
+							end
+						end
+					end
+				end
+				goto continue
+			end
+			]]--
+
+			::continue::
+		end
+	end)
+
+	while not done do
+		--
+	end
+	ansikit.showCursor()
+	ansikit.screenMain()
+end
+
+function read()
+	terminal.saveState()
+	terminal.setRaw()
+	local c = hilbish.editor.readChar()
+
+	terminal.restoreState()
+	return c
+end
+
+return Greenhouse

nature/greenhouse/page.lua

@@ -0,0 +1,32 @@
+local Object = require 'nature.object'
+
+local Page = Object:extend()
+
+function Page:new(title, text)
+	self:setText(text)
+	self.title = title or 'Page'
+	self.lazy = false
+	self.loaded = true
+	self.children = {}
+end
+
+function Page:setText(text)
+	self.lines = string.split(text, '\n')
+end
+
+function Page:setTitle(title)
+	self.title = title
+end
+
+function Page:dynamic(initializer)
+	self.initializer = initializer
+	self.lazy = true
+	self.loaded = false
+end
+
+function Page:initialize()
+	self.initializer()
+	self.loaded = true
+end
+
+return Page

nature/init.lua

@@ -6,6 +6,18 @@ local fs = require 'fs'
 package.path = package.path .. ';' .. hilbish.dataDir .. '/?/init.lua'
 .. ';' .. hilbish.dataDir .. '/?/?.lua' .. ";" .. hilbish.dataDir .. '/?.lua'
 
+hilbish.module.paths = '?.so;?/?.so;'
+.. hilbish.userDir.data .. 'hilbish/libs/?/?.so'
+.. ";" .. hilbish.userDir.data .. 'hilbish/libs/?.so'
+
+table.insert(package.searchers, function(module)
+	local path = package.searchpath(module, hilbish.module.paths)
+	if not path then return nil end
+
+	-- it didnt work normally, idk
+	return function() return hilbish.module.load(path) end, path
+end)
+
 require 'nature.commands'
 require 'nature.completions'
 require 'nature.opts'

nature/object.lua

@@ -0,0 +1,59 @@
+---@class nature.object
+---@field super nature.object
+local Object = {}
+Object.__index = Object
+
+---Can be overrided by child objects to implement a constructor.
+function Object:new() end
+
+---@return nature.object
+function Object:extend()
+  local cls = {}
+  for k, v in pairs(self) do
+    if k:find("__") == 1 then
+      cls[k] = v
+    end
+  end
+  cls.__index = cls
+  cls.super = self
+  setmetatable(cls, self)
+  return cls
+end
+
+---Check if the object is strictly of the given type.
+---@param T any
+---@return boolean
+function Object:is(T)
+  return getmetatable(self) == T
+end
+
+---Check if the object inherits from the given type.
+---@param T any
+---@return boolean
+function Object:extends(T)
+  local mt = getmetatable(self)
+  while mt do
+    if mt == T then
+      return true
+    end
+    mt = getmetatable(mt)
+  end
+  return false
+end
+
+---Metamethod to get a string representation of an object.
+---@return string
+function Object:__tostring()
+  return "Object"
+end
+
+---Methamethod to allow using the object call as a constructor.
+---@return nature.object
+function Object:__call(...)
+  local obj = setmetatable({}, self)
+  obj:new(...)
+  return obj
+end
+
+
+return Object

readline/codes.go

@@ -1,5 +1,7 @@
 package readline
 
+import "os"
+
 // Character codes
 const (
 	charCtrlA = iota + 1
@@ -134,3 +136,57 @@ const (
 const (
 	seqCtermFg255 = "\033[48;5;255m"
 )
+
+// TODO: return whether its actually a sequence or not
+// remedies the edge case of someone literally typing Ctrl-A for example.
+func (rl *Instance) ReadChar() string {
+	b := make([]byte, 1024)
+	i, _ := os.Stdin.Read(b)
+	r := []rune(string(b))
+	s := string(r[:i])
+
+	switch b[0] {
+		case charCtrlA: return "Ctrl-A"
+		case charCtrlB: return "Ctrl-B"
+		case charCtrlC: return "Ctrl-C"
+		case charEOF: return "Ctrl-D"
+		case charCtrlE: return "Ctrl-E"
+		case charCtrlF: return "Ctrl-F"
+		case charCtrlG: return "Ctrl-G"
+		case charBackspace, charBackspace2: return "Backspace"
+		case charTab: return "Tab"
+		case charCtrlK: return "Ctrl-K"
+		case charCtrlL: return "Ctrl-L"
+		case charCtrlN: return "Ctrl-N"
+		case charCtrlO: return "Ctrl-O"
+		case charCtrlP: return "Ctrl-P"
+		case charCtrlQ: return "Ctrl-Q"
+		case charCtrlR: return "Ctrl-R"
+		case charCtrlS: return "Ctrl-S"
+		case charCtrlT: return "Ctrl-T"
+		case charCtrlU: return "Ctrl-U"
+		case charCtrlV: return "Ctrl-V"
+		case charCtrlW: return "Ctrl-W"
+		case charCtrlX: return "Ctrl-X"
+		case charCtrlY: return "Ctrl-Y"
+		case charCtrlZ: return "Ctrl-Z"
+		case '\r': fallthrough
+		case '\n': return "Enter"
+		case charEscape:
+			switch s {
+				case string(charEscape): return "Escape"
+				case seqUp: return "Up"
+				case seqDown: return "Down"
+				case seqBackwards: return "Left"
+				case seqForwards: return "Right"
+				case seqCtrlLeftArrow: return "Ctrl-Left"
+				case seqCtrlRightArrow: return "Ctrl-Right"
+				case seqCtrlDelete, seqCtrlDelete2: return "Ctrl-Delete"
+				case seqHome, seqHomeSc: return "Home"
+				case seqEnd, seqEndSc: return "End"
+				case seqDelete, seqDelete2: return "Delete"
+			}
+	}
+
+	return s
+}

readline/history.go

@@ -156,8 +156,8 @@ func (rl *Instance) walkHistory(i int) {
 	rl.updateHelpers()
 
 	// In order to avoid having to type j/k twice each time for history navigation,
-	// we walk once again. This only ever happens when we aren't out of bounds.
-	if dedup && old == new {
+	// we walk once again. This only ever happens when we aren't out of bounds and the last history item was not a empty string.
+	if new != "" && dedup && old == new {
 		rl.walkHistory(i)
 	}
 }

sink.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"strings"
 
 	"hilbish/util"
 
@@ -31,6 +32,7 @@ func setupSinkType(rtm *rt.Runtime) {
 	sinkFuncs := map[string]util.LuaExport{
 		"flush": {luaSinkFlush, 1, false},
 		"read": {luaSinkRead, 1, false},
+		"readAll": {luaSinkReadAll, 1, false},
 		"autoFlush": {luaSinkAutoFlush, 2, false},
 		"write": {luaSinkWrite, 2, false},
 		"writeln": {luaSinkWriteln, 2, false},
@@ -65,10 +67,42 @@ func setupSinkType(rtm *rt.Runtime) {
 	l.SetRegistry(sinkMetaKey, rt.TableValue(sinkMeta))
 }
 
+
+// #member
+// readAll() -> string
+// --- @returns string
+// Reads all input from the sink.
+func luaSinkReadAll(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
+	if err := c.Check1Arg(); err != nil {
+		return nil, err
+	}
+
+	s, err := sinkArg(c, 0)
+	if err != nil {
+		return nil, err
+	}
+
+	lines := []string{}
+	for {
+		line, err := s.reader.ReadString('\n')
+		if err != nil {
+			if err == io.EOF {
+				break
+			}
+
+			return nil, err
+		}
+
+		lines = append(lines, line)
+	}
+
+	return c.PushingNext1(t.Runtime, rt.StringValue(strings.Join(lines, ""))), nil
+}
+
 // #member
 // read() -> string
 // --- @returns string
-// Reads input from the sink.
+// Reads a liine of input from the sink.
 func luaSinkRead(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	if err := c.Check1Arg(); err != nil {
 		return nil, err

testplugin/testplugin.go

@@ -0,0 +1,9 @@
+package main
+
+import (
+	rt "github.com/arnodel/golua/runtime"
+)
+
+func Loader(rtm *rt.Runtime) rt.Value {
+	return rt.StringValue("hello world!")
+}

website/config.toml

@@ -29,6 +29,9 @@ enableGitInfo = true
 [markup.goldmark.renderer]
 unsafe = true
 
+[markup.highlight]
+style = 'pastie'
+
 [author]
 	[author.sammyette]
 		name = 'sammyette'

website/content/docs

@@ -0,0 +1 @@
+../../docs

website/content/docs/api

@@ -1 +0,0 @@
-../../../docs/api/

website/themes/hsh/assets/css/syntax.css

@@ -0,0 +1,85 @@
+/* Background */ .bg { background-color: #edfdff; }
+/* PreWrapper */ .chroma { background-color: #edfdff; }
+/* Other */ .chroma .x {  }
+/* Error */ .chroma .err { color: #a61717; background-color: #e3d2d2 }
+/* CodeLine */ .chroma .cl {  }
+/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
+/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
+/* LineHighlight */ .chroma .hl { background-color: #edfdff }
+/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
+/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
+/* Line */ .chroma .line { display: flex; }
+/* Keyword */ .chroma .k { color: #008800; font-weight: bold }
+/* KeywordConstant */ .chroma .kc { color: #008800; font-weight: bold }
+/* KeywordDeclaration */ .chroma .kd { color: #008800; font-weight: bold }
+/* KeywordNamespace */ .chroma .kn { color: #008800; font-weight: bold }
+/* KeywordPseudo */ .chroma .kp { color: #008800 }
+/* KeywordReserved */ .chroma .kr { color: #008800; font-weight: bold }
+/* KeywordType */ .chroma .kt { color: #888888; font-weight: bold }
+/* Name */ .chroma .n {  }
+/* NameAttribute */ .chroma .na { color: #336699 }
+/* NameBuiltin */ .chroma .nb { color: #003388 }
+/* NameBuiltinPseudo */ .chroma .bp {  }
+/* NameClass */ .chroma .nc { color: #bb0066; font-weight: bold }
+/* NameConstant */ .chroma .no { color: #003366; font-weight: bold }
+/* NameDecorator */ .chroma .nd { color: #555555 }
+/* NameEntity */ .chroma .ni {  }
+/* NameException */ .chroma .ne { color: #bb0066; font-weight: bold }
+/* NameFunction */ .chroma .nf { color: #0066bb; font-weight: bold }
+/* NameFunctionMagic */ .chroma .fm {  }
+/* NameLabel */ .chroma .nl { color: #336699; font-style: italic }
+/* NameNamespace */ .chroma .nn { color: #bb0066; font-weight: bold }
+/* NameOther */ .chroma .nx {  }
+/* NameProperty */ .chroma .py { color: #336699; font-weight: bold }
+/* NameTag */ .chroma .nt { color: #bb0066; font-weight: bold }
+/* NameVariable */ .chroma .nv { color: #336699 }
+/* NameVariableClass */ .chroma .vc { color: #336699 }
+/* NameVariableGlobal */ .chroma .vg { color: #dd7700 }
+/* NameVariableInstance */ .chroma .vi { color: #3333bb }
+/* NameVariableMagic */ .chroma .vm {  }
+/* Literal */ .chroma .l {  }
+/* LiteralDate */ .chroma .ld {  }
+/* LiteralString */ .chroma .s { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringAffix */ .chroma .sa { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringBacktick */ .chroma .sb { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringChar */ .chroma .sc { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringDelimiter */ .chroma .dl { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringDoc */ .chroma .sd { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringDouble */ .chroma .s2 { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringEscape */ .chroma .se { color: #0044dd; background-color: #fff0f0 }
+/* LiteralStringHeredoc */ .chroma .sh { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringInterpol */ .chroma .si { color: #3333bb; background-color: #fff0f0 }
+/* LiteralStringOther */ .chroma .sx { color: #22bb22; background-color: #f0fff0 }
+/* LiteralStringRegex */ .chroma .sr { color: #008800; background-color: #fff0ff }
+/* LiteralStringSingle */ .chroma .s1 { color: #dd2200; background-color: #fff0f0 }
+/* LiteralStringSymbol */ .chroma .ss { color: #aa6600; background-color: #fff0f0 }
+/* LiteralNumber */ .chroma .m { color: #0000dd; font-weight: bold }
+/* LiteralNumberBin */ .chroma .mb { color: #0000dd; font-weight: bold }
+/* LiteralNumberFloat */ .chroma .mf { color: #0000dd; font-weight: bold }
+/* LiteralNumberHex */ .chroma .mh { color: #0000dd; font-weight: bold }
+/* LiteralNumberInteger */ .chroma .mi { color: #0000dd; font-weight: bold }
+/* LiteralNumberIntegerLong */ .chroma .il { color: #0000dd; font-weight: bold }
+/* LiteralNumberOct */ .chroma .mo { color: #0000dd; font-weight: bold }
+/* Operator */ .chroma .o {  }
+/* OperatorWord */ .chroma .ow { color: #008800 }
+/* Punctuation */ .chroma .p {  }
+/* Comment */ .chroma .c { color: #888888 }
+/* CommentHashbang */ .chroma .ch { color: #888888 }
+/* CommentMultiline */ .chroma .cm { color: #888888 }
+/* CommentSingle */ .chroma .c1 { color: #888888 }
+/* CommentSpecial */ .chroma .cs { color: #cc0000; background-color: #fff0f0; font-weight: bold }
+/* CommentPreproc */ .chroma .cp { color: #cc0000; font-weight: bold }
+/* CommentPreprocFile */ .chroma .cpf { color: #cc0000; font-weight: bold }
+/* Generic */ .chroma .g {  }
+/* GenericDeleted */ .chroma .gd { color: #000000; background-color: #ffdddd }
+/* GenericEmph */ .chroma .ge { font-style: italic }
+/* GenericError */ .chroma .gr { color: #aa0000 }
+/* GenericHeading */ .chroma .gh { color: #333333 }
+/* GenericInserted */ .chroma .gi { color: #000000; background-color: #ddffdd }
+/* GenericOutput */ .chroma .go { color: #888888 }
+/* GenericPrompt */ .chroma .gp { color: #555555 }
+/* GenericStrong */ .chroma .gs { font-weight: bold }
+/* GenericSubheading */ .chroma .gu { color: #666666 }
+/* GenericTraceback */ .chroma .gt { color: #aa0000 }
+/* GenericUnderline */ .chroma .gl { text-decoration: underline }
+/* TextWhitespace */ .chroma .w { color: #bbbbbb }

website/themes/hsh/layouts/partials/head.html

@@ -23,7 +23,10 @@
 	<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor" crossorigin="anonymous">
 	<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js" integrity="sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2" crossorigin="anonymous"></script>
 	<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css" integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin="anonymous" referrerpolicy="no-referrer" />
+	{{ $syntax := resources.Get "css/syntax.css" | resources.Minify | resources.Fingerprint }}
+	<link rel="stylesheet" href="{{ $syntax.RelPermalink }}" integrity="{{ $syntax.Data.Integrity }}">
 
+	</link>
 	<style>
 	.heading > .heading-link {
 		opacity: 0
@@ -34,5 +37,38 @@
 		opacity: 1;
 		transition: all .1s ease-in;
 	}
+
+	@keyframes highlight {
+		0% {
+			background: none
+		}
+		50% {
+			background: #fff2cf;
+		}
+		100% {
+			background: none;
+		}
+	}
+
+	div:target {
+		animation: highlight 1.2s;
+		animation-timing-function: cubic-bezier(1,-0.02,.45,.89);
+	}
+
+	table {
+		border-width: 1px;
+		border-style: solid;
+		border-color: #565c64;;
+		border-collapse: collapse;
+		margin-bottom: 12px;
+	}
+
+	table td {
+		padding: 5px;
+	}
+
+	table tr {
+		border-width: 1px;
+	}
 	</style>
 </head>