diff --git a/.gitignore b/.gitignore index 44b693c..660de32 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,4 @@ .vscode # Output -generated-index +index.html diff --git a/README.md b/README.md index 9b7c7af..690abd9 100644 --- a/README.md +++ b/README.md @@ -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 DESCRIPTION -`NOFANCY` -`bool` -`false` +NOFANCY +bool +false Whether to print things like the "Generation successful" message -`RECURSE` -`bool` -`false` +RECURSE +bool +false Whether to recurse downwards and create a directory index for all directories found -`MINIFY` -`bool` -`false` +MINIFY +bool +false Whether to minify the final output. This will just remove all newlines -`OUTPUT` -`str` -`./index.html` +OUTPUT +str +./index.html Where gendex should output it's generated HTML file to -`LOCALPATH` -`str` -`` -The local location of the specified directory. Used in the index's title and header. This value is always prefixed with a `/` +LOCALPATH +str + +The local location of the specified directory. Used in the index's title and header. This value is always prefixed with a / -`TEMPLATE` -`str` -`` +TEMPLATE +str + The absolute location of the .html template to use. Uses the standard template if empty