2
2
mirror of https://github.com/Hilbis/Hilbish synced 2025-06-06 12:32:03 +00:00

58 lines
7.7 KiB
HTML

<!doctype html>
<html class="bg-stone-50 dark:bg-neutral-900 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="/hilbish-flower.png" property="og:image"><meta content="Hilbish" property="og:title"><meta content="Hilbish" property="og:site_name"><meta content="website" property="og:type"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." property="og:description"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." name="description"><meta content="Lua,Shell,Hilbish,Linux,zsh,bash" name="keywords"><meta content property="og:url"></head><body class="min-h-screen flex flex-col"><nav class="flex sticky top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-12"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-6" src="/hilbish-flower.png"><span class="self-center text-2xl">Hilbish</span></a></div></div></nav><div class="flex flex-col"><div class="h-10 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 dark:bg-zinc-800/50 z-50"><label class="cursor-pointer" for="sidebar-toggle"><tag><svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 -960 960 960" width="24px" class="fill-black"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span>Module dirs</span></div><div class="grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="border-r border-r-zinc-300 col-start-1 row-start-1 sticky top-22 sm:top-12 h-full sm:h-svh bg-neutral-200 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 z-30"><div class="p-4 -mb-4 overflow-y-auto h-full"><h2 class="text-xl font-semibold mb-4">Sidebar</h2><ul><li class="mb-2">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</li></ul></div></div><main class="col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30 px-4 pt-2"><h1 class="font-bold text-4xl">Module dirs</h1><h2 class="font-bold text-3xl" id="Introduction-The-dirs-module-defines-a-small-set-of-functions-to-store-and-manage-directories.">Introduction
The dirs module defines a small set of functions to store and manage
directories.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|&lt;a-href=&quot;setOld&quot;&gt;setOld(d)&lt;/a&gt;|Sets-the-old-directory-string.|-|&lt;a-href=&quot;recent&quot;&gt;recent(idx)&lt;/a&gt;|Get-entry-from-recent-directories-list-based-on-index.|-|&lt;a-href=&quot;push&quot;&gt;push(dir)&lt;/a&gt;|Add-dir-to-the-recent-directories-list.|-|&lt;a-href=&quot;pop&quot;&gt;pop(num)&lt;/a&gt;|Remove-the-specified-amount-of-dirs-from-the-recent-directories-list.|-|&lt;a-href=&quot;peak&quot;&gt;peak(num)&lt;/a&gt;|Look-at-num-amount-of-recent-directories-starting-from-the-latest.|-&lt;hr&gt;-&lt;div-id=&#39;peak&#39;&gt;-&lt;h4-class=&#39;heading&#39;&gt;-dirs.peak(num)-&lt;a-href=&quot;peak&quot;-class=&#39;heading-link&#39;&gt;- &lt;i-class=&quot;fas-fa-paperclip&quot;&gt;&lt;/i&gt;-&lt;/a&gt;-&lt;/h4&gt;">Functions
|||
|----|----|
|&lt;a href=&quot;#setOld&quot;&gt;setOld(d)&lt;/a&gt;|Sets the old directory string.|
|&lt;a href=&quot;#recent&quot;&gt;recent(idx)&lt;/a&gt;|Get entry from recent directories list based on index.|
|&lt;a href=&quot;#push&quot;&gt;push(dir)&lt;/a&gt;|Add <code>dir</code> to the recent directories list.|
|&lt;a href=&quot;#pop&quot;&gt;pop(num)&lt;/a&gt;|Remove the specified amount of dirs from the recent directories list.|
|&lt;a href=&quot;#peak&quot;&gt;peak(num)&lt;/a&gt;|Look at <code>num</code> amount of recent directories, starting from the latest.|
&lt;hr&gt;
&lt;div id=&#39;peak&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
dirs.peak(num)
&lt;a href=&quot;#peak&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</h2><p>Look at <code>num</code> amount of recent directories, starting from the latest.
This returns a table of recent directories, up to the <code>num</code> amount.
#### Parameters
<code>num</code> **<code>number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;pop&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
dirs.pop(num)
&lt;a href=&quot;#pop&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Remove the specified amount of dirs from the recent directories list.
#### Parameters
<code>num</code> **<code>number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;push&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
dirs.push(dir)
&lt;a href=&quot;#push&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Add <code>dir</code> to the recent directories list.
#### Parameters
<code>dir</code> **<code>string</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;recent&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
dirs.recent(idx)
&lt;a href=&quot;#recent&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Get entry from recent directories list based on index.
#### Parameters
<code>idx</code> **<code>number</code>** </p><p>&lt;/div&gt;</p><p>&lt;hr&gt;
&lt;div id=&#39;setOld&#39;&gt;
&lt;h4 class=&#39;heading&#39;&gt;
dirs.setOld(d)
&lt;a href=&quot;#setOld&quot; class=&#39;heading-link&#39;&gt;
&lt;i class=&quot;fas fa-paperclip&quot;&gt;&lt;/i&gt;
&lt;/a&gt;
&lt;/h4&gt;</p><p>Sets the old directory string.
#### Parameters
<code>d</code> **<code>string</code>** </p><p>&lt;/div&gt;</p></main></div></div><footer class="py-4 px-6 flex flex-row justify-around border-t border-t-zinc-300"><div class="flex flex-col"><a class="flex items-center gap-1" href><img class="h-24" src="/hilbish-flower.png"><span class="self-center text-6xl">Hilbish</span></a><span class="text-xl">The Moon-powered shell!</span><span class="text-light text-neutral-500">MIT License, copyright sammyette 2025</span></div><div class="flex flex-col"><a href="https://github.com/Rosettea/Hilbish"><span class="text-pink-300 text-light">GitHub</span></a></div></footer></body></html>