Installation • Usage • Build Status • Contributing • License
SourceIndex is a simple utility for generating index page for source code archives.
To build the SourceIndex from scratch, make sure you have a working Go 1.17+ workspace (instructions), then:
go install github.com/essentialkaos/source-index
You can generate completion for bash, zsh or fish shell.
Bash:
sudo source-index --completion=bash 1> /etc/bash_completion.d/source-indexZSH:
sudo source-index --completion=zsh 1> /usr/share/zsh/site-functions/source-indexFish:
sudo source-index --completion=fish 1> /usr/share/fish/vendor_completions.d/source-index.fishUsage: source-index {options} dir
Options
--output, -o file Output file (index.html by default)
--template, -t file Template (template.tpl by default)
--no-color, -nc Disable colors in output
--help, -h Show this help message
--version, -v Show version
| Branch | Status |
|---|---|
master |
 |
develop |
|
Before contributing to this project please read our Contributing Guidelines.
