https://github.com/looztra/asdf-auto-doc
Asdf plugin to install the GHA auto-doc tool
https://github.com/looztra/asdf-auto-doc
Last synced: about 1 year ago
JSON representation
Asdf plugin to install the GHA auto-doc tool
- Host: GitHub
- URL: https://github.com/looztra/asdf-auto-doc
- Owner: looztra
- License: other
- Created: 2023-07-14T18:35:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-30T18:41:50.000Z (about 1 year ago)
- Last Synced: 2025-03-30T19:51:16.148Z (about 1 year ago)
- Language: Shell
- Size: 66.4 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: contributing.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# asdf-auto-doc
[](https://github.com/looztra/asdf-auto-doc/actions/workflows/build.yml) [](https://github.com/looztra/asdf-auto-doc/actions/workflows/lint.yml)
[auto-doc](https://github.com/tj-actions/auto-doc) plugin for the [asdf version manager](https://asdf-vm.com).
## Contents
- [asdf-auto-doc](#asdf-auto-doc)
- [Contents](#contents)
- [Dependencies](#dependencies)
- [Install](#install)
- [Contributing](#contributing)
- [License](#license)
## Dependencies
- `bash`, `curl`, `tar`: generic POSIX utilities.
- `GITHUB_API_TOKEN`: will be used if it is set.
## Install
Plugin:
```shell
asdf plugin add auto-doc
# or
asdf plugin add auto-doc https://github.com/looztra/asdf-auto-doc.git
```
auto-doc:
```shell
# Show all installable versions
asdf list-all auto-doc
# Install specific version
asdf install auto-doc latest
# Set a version globally (on your ~/.tool-versions file)
asdf global auto-doc latest
# Now auto-doc commands are available
auto-doc --help
```
Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to
install & manage versions.
## Contributing
Contributions of any kind welcome! See the [contributing guide](contributing.md).
[Thanks goes to these contributors](https://github.com/looztra/asdf-auto-doc/graphs/contributors)!
## License
See [LICENSE](LICENSE) © [Christophe Furmaniak](https://github.com/looztra/)