https://github.com/essentialkaos/shdoc
Tool for viewing and exporting docs for shell scripts
https://github.com/essentialkaos/shdoc
bash documentation tool utility viewer
Last synced: 11 months ago
JSON representation
Tool for viewing and exporting docs for shell scripts
- Host: GitHub
- URL: https://github.com/essentialkaos/shdoc
- Owner: essentialkaos
- License: apache-2.0
- Created: 2015-12-01T22:49:14.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-11-13T09:07:31.000Z (over 1 year ago)
- Last Synced: 2024-11-13T10:20:04.184Z (over 1 year ago)
- Topics: bash, documentation, tool, utility, viewer
- Language: Go
- Homepage: https://kaos.sh/shdoc
- Size: 333 KB
- Stars: 12
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Usage Demo • Installation • Usage • Test & Coverage Status • Contributing • License
`shdoc` is a tool for viewing and exporting documentation for shell scripts.
### Usage Demo
[](#usage-demo)
### Installation
#### From source
Make sure you have a working Go [1.23+](https://github.com/essentialkaos/.github/blob/master/GO-VERSION-SUPPORT.md) workspace ([instructions](https://go.dev/doc/install)), then:
```bash
go install github.com/essentialkaos/shdoc@latest
```
#### Prebuilt binaries
You can download prebuilt binaries for Linux and macOS from [EK Apps Repository](https://apps.kaos.st/shdoc/latest).
To install the latest prebuilt version of bibop, do:
```bash
bash <(curl -fsSL https://apps.kaos.st/get) shdoc
```
### Command-line completion
You can generate completion for `bash`, `zsh` or `fish` shell.
Bash:
```
sudo shdoc --completion=bash 1> /etc/bash_completion.d/shdoc
```
ZSH:
```
sudo shdoc --completion=zsh 1> /usr/share/zsh/site-functions/shdoc
```
Fish:
```
sudo shdoc --completion=fish 1> /usr/share/fish/vendor_completions.d/shdoc.fish
```
### Usage
### Test & Coverage Status
| Branch | CI | Coveralls |
|--------|----------|-----------|
| `master` | [](https://kaos.sh/w/shdoc/ci?query=branch:master) | [](https://kaos.sh/c/shdoc?branch=master) |
| `develop` | [](https://kaos.sh/w/shdoc/ci?query=branch:develop) | [](https://kaos.sh/c/shdoc?branch=develop) |
### Contributing
Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/.github/blob/master/CONTRIBUTING.md).
### License
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
