mirror of
				https://github.com/sammy-ette/Hilbish
				synced 2025-08-10 02:52:03 +00:00 
			
		
		
		
	fix: add table heading
This commit is contained in:
		
							parent
							
								
									681d45f892
								
							
						
					
					
						commit
						38b909bb54
					
				| @ -123,6 +123,9 @@ for iface, dps in pairs(pieces) do | ||||
| 			table.remove(descriptions[iface], 1) | ||||
| 			f:write(string.format('\n## Introduction\n%s\n\n', table.concat(descriptions[iface], '\n'))) | ||||
| 			f:write('## Functions\n') | ||||
| 			f:write([[||| | ||||
| |----|----| | ||||
| ]]) | ||||
| 			tocPos = f:seek() | ||||
| 		end | ||||
| 	end | ||||
|  | ||||
| @ -20,6 +20,8 @@ The `hilbish.message` type is a table with the following keys: | ||||
| `read` (boolean): Whether the full message has been read or not. | ||||
| 
 | ||||
| ## Functions | ||||
| ||| | ||||
| |----|----| | ||||
| |<a href="#unreadCount">unreadCount()</a>|Returns the amount of unread messages.| | ||||
| |<a href="#readAll">readAll()</a>|Marks all messages as read.| | ||||
| |<a href="#send">send(message)</a>|Sends a message.| | ||||
| @ -27,7 +29,6 @@ The `hilbish.message` type is a table with the following keys: | ||||
| |<a href="#delete">delete(idx)</a>|Deletes the message at `idx`.| | ||||
| |<a href="#clear">clear()</a>|Deletes all messages.| | ||||
| |<a href="#all">all()</a>|Returns all messages.| | ||||
| 
 | ||||
| <hr> | ||||
| <div id='all'> | ||||
| <h4 class='heading'> | ||||
| @ -42,7 +43,6 @@ Returns all messages. | ||||
| This function has no parameters.   | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='clear'> | ||||
| <h4 class='heading'> | ||||
| @ -57,7 +57,6 @@ Deletes all messages. | ||||
| This function has no parameters.   | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='delete'> | ||||
| <h4 class='heading'> | ||||
| @ -74,7 +73,6 @@ Deletes the message at `idx`. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='read'> | ||||
| <h4 class='heading'> | ||||
| @ -91,7 +89,6 @@ Marks a message at `idx` as read. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='send'> | ||||
| <h4 class='heading'> | ||||
| @ -108,7 +105,6 @@ Sends a message. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='readAll'> | ||||
| <h4 class='heading'> | ||||
| @ -123,7 +119,6 @@ Marks all messages as read. | ||||
| This function has no parameters.   | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='unreadCount'> | ||||
| <h4 class='heading'> | ||||
|  | ||||
| @ -120,7 +120,6 @@ This is the equivalent of using `source`. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='getCurrent'> | ||||
| <h4 class='heading'> | ||||
| @ -135,7 +134,6 @@ Returns the current runner by name. | ||||
| This function has no parameters.   | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='setCurrent'> | ||||
| <h4 class='heading'> | ||||
| @ -152,7 +150,6 @@ Sets Hilbish's runner mode by name. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='add'> | ||||
| <h4 class='heading'> | ||||
| @ -173,7 +170,6 @@ If runner is a table, it must have the run function in it. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='get'> | ||||
| <h4 class='heading'> | ||||
| @ -190,7 +186,6 @@ Get a runner by name. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='set'> | ||||
| <h4 class='heading'> | ||||
| @ -212,7 +207,6 @@ The runner table must have the run function in it. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='exec'> | ||||
| <h4 class='heading'> | ||||
|  | ||||
| @ -13,12 +13,13 @@ The dirs module defines a small set of functions to store and manage | ||||
| directories. | ||||
| 
 | ||||
| ## Functions | ||||
| ||| | ||||
| |----|----| | ||||
| |<a href="#recent">recent(idx)</a>|Get entry from recent directories list based on index.| | ||||
| |<a href="#pop">pop(num)</a>|Remove the specified amount of dirs from the recent directories list.| | ||||
| |<a href="#peak">peak(num)</a>|Look at `num` amount of recent directories, starting from the latest.| | ||||
| |<a href="#push">push(dir)</a>|Add `dir` to the recent directories list.| | ||||
| |<a href="#setOld">setOld(d)</a>|Sets the old directory string.| | ||||
| 
 | ||||
| <hr> | ||||
| <div id='setOld'> | ||||
| <h4 class='heading'> | ||||
| @ -35,7 +36,6 @@ Sets the old directory string. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='push'> | ||||
| <h4 class='heading'> | ||||
| @ -52,7 +52,6 @@ Add `dir` to the recent directories list. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='peak'> | ||||
| <h4 class='heading'> | ||||
| @ -70,7 +69,6 @@ This returns  a table of recent directories, up to the `num` amount. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='pop'> | ||||
| <h4 class='heading'> | ||||
| @ -87,7 +85,6 @@ Remove the specified amount of dirs from the recent directories list. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='recent'> | ||||
| <h4 class='heading'> | ||||
|  | ||||
| @ -15,10 +15,11 @@ This is only documented for the sake of it. It's only intended use | ||||
| is by the Greenhouse pager. | ||||
| 
 | ||||
| ## Functions | ||||
| ||| | ||||
| |----|----| | ||||
| |<a href="#renderCodeBlock">renderCodeBlock(text)</a>|Assembles and renders a code block. This returns| | ||||
| |<a href="#highlight">highlight(text)</a>|Performs basic Lua code highlighting.| | ||||
| |<a href="#renderInfoBlock">renderInfoBlock(type, text)</a>|Renders an info block. An info block is a block of text with| | ||||
| 
 | ||||
| <hr> | ||||
| <div id='renderInfoBlock'> | ||||
| <h4 class='heading'> | ||||
| @ -39,7 +40,6 @@ an icon and styled text block. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='highlight'> | ||||
| <h4 class='heading'> | ||||
| @ -56,7 +56,6 @@ Performs basic Lua code highlighting. | ||||
| 
 | ||||
| </div> | ||||
| 
 | ||||
| 
 | ||||
| <hr> | ||||
| <div id='renderCodeBlock'> | ||||
| <h4 class='heading'> | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user