Comments (2)
I have extensively used terraform-docs, and I like their idea here, but I decided to implement documentation generation using gotemplates. If you want to do what you describe, you can do the following:
cp README.md README.gotmpl
Add a section to the new file wherever you'd like docs to appear:
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}
{{ template "chart.badgesSection" . }}
{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}
{{ template "chart.maintainersSection" . }}
{{ template "chart.sourcesSection" . }}
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
then run:
helm-docs --template-files=./REAMDME.md.gotmpl
it should print the standard template to your README.md file.
If you'd like a simpler template rather than the 12 lines I've pasted above, I'm happy to implement that, but I like the gotemplate approach here and I'm not changing that particular implementation choice.
from helm-docs.
Hi,
I'm trying to use .gotmpl file to merge the docs with the existing README but it's failing with the following error:
Error generating gotemplates for chart chart:184: function "variables" not defined
I also looked under example-charts/custom-template
and have it set up the same way but still getting the same error. I'm using helm-docs v1.8.1
from helm-docs.
Related Issues (20)
- Add support for sprig functions like helm does
- Enable filtering `valuesTable` to a subset of values
- invalid memory address or nil pointer error HOT 4
- How to use pre-formatted multiline strings in description field HOT 2
- Pre-commit hooks ignores -s argument HOT 3
- Option to not include the helm-docs version in README HOT 5
- document-dependency-values does not work with OCI dependency HOT 3
- Cannot include mustache/handlebar templates in example docs HOT 2
- Support for creating docs of named templates in library charts HOT 1
- Ignore comment HOT 1
- feature: output results as json (or other formats) HOT 2
- feature request: "Strict mode" HOT 6
- Implement something like helm's `include` function
- Pipe `|` breaks table output of `values.yml`
- helm-docs as pre-commit marked as failed but successfully replaces files HOT 1
- Add support for conditional dependencies
- Output docs for values that are commented out HOT 4
- helm-docs write extra empty line HOT 5
- Q&A - Auto sorting HOT 2
- custom template not defined error
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from helm-docs.