benthos-plugin-example icon indicating copy to clipboard operation
benthos-plugin-example copied to clipboard

Published 20 hours ago • verified publisher icon benthosdev

[Question]: generate documentation

Open artemklevtsov opened this issue 9 months ago • 1 comments

Hi, Are there any option to generate html/markdown documentation for the custom builds? I found docs_gen but it is not exported as package.

artemklevtsov avatar Feb 23 '25 05:02 artemklevtsov

I think the best workaround for now is to clone the Connect repo locally, do go install ./cmd/tools/docs_gen (sadly, this replace directive is still required, so go install github.com/redpanda-data/connect/v4/cmd/tools/docs_gen@latest doesn't work) and then leverage https://pkg.go.dev/git.sr.ht/~shulhan/asciidoctor-go to generate HTML.

Alternatively, the code in docs_gen is just a simple wrapper over public Benthos APIs, so you can build your own tool.

mihaitodor avatar Feb 23 '25 22:02 mihaitodor