26 lines
945 B
Markdown
26 lines
945 B
Markdown
# indir
|
|
|
|
a nifty static file indexer
|
|
|
|
indir provides a nice, simple web frontend for browsing your file directories!
|
|
heavily inspired by traditional file indexers provided by the likes of nginx
|
|
and apache, with some modern amenities on top :)
|
|
|
|
## usage
|
|
```sh
|
|
indir [--host address] [--port port] [--root http_root] directory
|
|
|
|
--help shows this help message
|
|
--host address hosts on the specified address
|
|
--port port hosts on the specified port
|
|
--root http_root hosts on the specified subdirectory, i.e. `/files/`
|
|
```
|
|
|
|
## features
|
|
|
|
- **index files:** if available, indir will prefer serving an `index.html` file
|
|
instead of a directory listing.
|
|
- **custom CSS:** indir will append the contents of a local `index.css` file to
|
|
the default stylesheet, if applicable.
|
|
- **readme files:** adding a `readme.md` file (case insensitive) will append
|
|
its contents beneath the directory tree in rendered markdown.
|