Know what the script does.
A short description of version 0.1.0, including its limits.
Reading the directory
The script enumerates regular files, sorts their relative paths case-insensitively, and renders one link per file. File bodies are not read. It records no access time, owner name, or absolute source path in the generated page.
Entries that are skipped
- Files and directories whose names start with a dot.
- Symbolic links, whether they point to files or directories.
- Subdirectories unless
--recursiveis set. - Files outside a selected extension filter.
The input directory itself must not be a symbolic link. This is a small utility for a stable directory that you control, not a hardened service for untrusted, concurrently changing filesystems.
Links and portability
With --output, file URLs are relative to the generated page. Moving the page and its referenced files together preserves those links when their relative layout stays the same. Moving only the page may break them.
HTML handling
Names and the title are escaped as text. Filenames are percent-encoded in URLs. The output contains no JavaScript, external fonts, analytics, or remote resources.
Limits
- No full-text search or file preview.
- No content copying, compression, synchronization, or backups.
- No authentication or access control.
- No automatic updates after files change.
- No file-size or performance guarantees for large trees.