Comments (5)
If you install this tool with "Go" this field is absent. Means that it is inconsistent. Better off having a simple flag for this field because when you generate new helm-docs with the new version tool mostly you have is just a different footer.
It's only for a user convenience especially when you have helm-docs diff checks at the server side.
from helm-docs.
You just have to define a custom
README.md.gotmpl
without the{{ template "helm-docs.versionFooter" . }}
part.
Why not to have just a flag to turn it off?
from helm-docs.
You just have to define a custom
README.md.gotmpl
without the{{ template "helm-docs.versionFooter" . }}
part.Why not to have just a flag to turn it off?
Because that's an anti-pattern. If you start going down the path of "we need a CLI flag / toggle for every single feature" you run into something very complicated, very quickly. It's much better from a practical, and maintainability perspective, if you cover most of the use cases that people want, and template the rest. If you want to see where the road you desire leads to, look no further than the git
CLI. Most people avoid any sort of interaction with that if possible because it has too many options.
from helm-docs.
You just have to define a custom README.md.gotmpl
without the {{ template "helm-docs.versionFooter" . }}
part.
from helm-docs.
You just have to define a custom
README.md.gotmpl
without the{{ template "helm-docs.versionFooter" . }}
part.
that would actually clutter the repository where I need to copy-paste the same template just to get rid of the final signature.
It's really useful to know which is the exact version on which a README has been generated? The most simple solution for me is just to get rid of the version e.g.
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
from helm-docs.
Related Issues (20)
- General Cleanup
- Notation annotation ignored when value is null
- How to document a list of objects?
- v1.11.1 does not have a release HOT 2
- helm-docs for helmfile HOT 2
- @latest produces different files than last release (1.11.0), missing a newline at the end of file HOT 4
- How to ignore dependency/Requirement list? HOT 1
- Not an issue
- Add support for sections and custom introduction HOT 2
- Add option to disable alphabetical sorting and keep declaration order HOT 2
- Missing versions in GitHub Releases HOT 3
- Update dependencies HOT 3
- bug: Binary artifacts renamed in `v1.11.2` HOT 7
- [Bug]: building for openSUSE fails with "unsafe.Slice requires go1.17 or later (-lang was set to go1.16; check go.mod)" HOT 4
- [Feat]: Move project to helm-docs organization HOT 3
- [Feat]: recursive with template from root (and template inside chart) HOT 1
- Not able to ignore chart folder even after adding entry in .helmdocsignore file HOT 5
- [Bug]: README shows the repo name as jnorwood/helm-docs rather than norwoodj/helm-docs in pre-commit examples
- [security] Vulnerabilities in the Container Image HOT 2
- Is it possible to add custom fields and use those values in generating docs
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.