BSD Portssysutils/helm-docs 1.14.2_4 FreeBSD
Automatically generate markdown documentation from helm charts
- System
- FreeBSD
- Repository
- FreeBSD ports
- Maintainer
- [email protected]
- Port added
- Last update
- Commit
d81b7ba3c3- License
- GPLv3
- Categories
- sysutils
- Package size
- 2859.0 KiB, 8965.2 KiB installed
Description
The helm-docs tool auto-generates documentation from helm charts into markdown files. The resulting files contain metadata about their respective chart and a table with each of the chart's values, their defaults, and an optional description parsed from comments.
The markdown generation is entirely gotemplate driven. The tool parses metadata from charts and generates a number of sub-templates that can be referenced in a template file (by default README.md.gotmpl). If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.
Install
Binary package:
pkg install helm-docsFrom the ports tree:
cd /usr/ports/sysutils/helm-docs/ && make install cleanTo depend on this port in another port's Makefile:
RUN_DEPENDS= helm-docs>0:sysutils/helm-docsPackages
The version each package repository carries. “-” means the repository builds no package of it, “n/a” that there is no such repository.
| Repository | aarch64 | amd64 | armv6 | armv7 | i386 |
|---|---|---|---|---|---|
| FreeBSD:14:latest | 1.14.2_3 | 1.14.2_3 | - | - | 1.14.2_3 |
| FreeBSD:14:quarterly | 1.14.2_3 | 1.14.2_3 | n/a | - | 1.14.2_3 |
| FreeBSD:15:latest | 1.14.2_3 | 1.14.2_3 | n/a | - | - |
| FreeBSD:15:quarterly | 1.14.2_3 | 1.14.2_3 | n/a | n/a | n/a |
| FreeBSD:16:latest | 1.14.2_2 | 1.14.2_3 | n/a | n/a | n/a |
| FreeBSD:16:quarterly | n/a | n/a | n/a | n/a | n/a |
Dependencies
The Makefile names none itself; they come from USES and USE_*.
The full lists below include those, and their dependencies in turn.
Build dependencies 1
No port depends on this one.
Configuration
Options name: sysutils_helm-docs
| Option | Default | Description |
|---|---|---|
| DOCS | off | Build and/or install documentation |
- USES
- go:modules
- Service scripts
- none
Files
distinfo 2
| File | Size | SHA256 |
|---|---|---|
| go/sysutils_helm-docs/norwoodj-helm-docs-v1.14.2_GH0/go.mod | 1581 | dcd4c3ab4b81c124a47bd941580492cd2ecd34808b3e8b727be095ad5fec3089 |
| go/sysutils_helm-docs/norwoodj-helm-docs-v1.14.2_GH0/norwoodj-helm-docs-v1.14.2_GH0.tar.gz | 109180 | 88d1b3401220b2032cd27974264d2dc0da8f9e7b67a8a929a0848505c4e4a0ae |