shdoc

command module
v0.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 26, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

README

GoReportCard codebeat badge Codacy badge Coverage Status
GitHub Actions CI Status GitHub Actions CodeQL Status

Usage DemoInstallationUsageTest & Coverage StatusContributingLicense


shdoc is a tool for viewing and exporting documentation for shell scripts.

Usage Demo

demo

Installation

From source

Make sure you have a working Go 1.21+ workspace (instructions), then:

go install github.com/essentialkaos/shdoc@latest

Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from EK Apps Repository.

To install the latest prebuilt version of bibop, do:

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 CI Coverage Status
develop CI Coverage Status

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
render

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL