Infrastructure/gendex
1
0
Fork 0
Code Issues Pull requests Releases Activity

Fix README

Browse source
This commit is contained in:
JeremyStar™ 2025-01-03 21:49:03 +01:00
parent f8f664ad29
commit 7f8736e57b
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
2 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -3,4 +3,4 @@
.vscode
# Output
generated-index
index.html

40
README.md
View file

@ -1,5 +1,5 @@
# gendex
gendex is a script which generates directory listings and outputs them into an `index.html` file.
gendex is a simple script that generates directory listings and writes them into an `index.html` file.
# Usage
@ -20,39 +20,39 @@ For a list of data types, see [this sos!bashutils documentation page](https://ba
<th>DESCRIPTION</th>
</tr>
<tr>
<th>`NOFANCY`</th>
<th>`bool`</th>
<th>`false`</th>
<td><code>NOFANCY</code></td>
<td><code>bool</code></td>
<td><code>false</code></td>
<th>Whether to print things like the "Generation successful" message</th>
</tr>
<tr>
<th>`RECURSE`</th>
<th>`bool`</th>
<th>`false`</th>
<td><code>RECURSE</code></td>
<td><code>bool</code></td>
<td><code>false</code></td>
<th>Whether to recurse downwards and create a directory index for all directories found</th>
</tr>
<tr>
<th>`MINIFY`</th>
<th>`bool`</th>
<th>`false`</th>
<td><code>MINIFY</code></td>
<td><code>bool</code></td>
<td><code>false</code></td>
<th>Whether to minify the final output. This will just remove all newlines</th>
</tr>
<tr>
<th>`OUTPUT`</th>
<th>`str`</th>
<th>`./index.html`</th>
<td><code>OUTPUT</code></td>
<td><code>str</code></td>
<td><code>./index.html</code></td>
<th>Where gendex should output it's generated HTML file to</th>
</tr>
<tr>
<th>`LOCALPATH`</th>
<th>`str`</th>
<th>``</th>
<th>The local location of the specified directory. Used in the index's title and header. This value is always prefixed with a `/`</th>
<td><code>LOCALPATH</code></td>
<td><code>str</code></td>
<td><code></code></td>
<td>The local location of the specified directory. Used in the index's title and header. This value is always prefixed with a <code>/</code></td>
</tr>
<tr>
<th>`TEMPLATE`</th>
<th>`str`</th>
<th>``</th>
<td><code>TEMPLATE</code></td>
<td><code>str</code></td>
<td><code></code></td>
<th>The absolute location of the .html template to use. Uses the standard template if empty</th>
</tr>
</table>