Custom Component: Readme

[ludeeus]

Use Jinja and data from Home Assistant to generate your README.md file

What?

Generate a README.md file in your configuration dir with Jinja templates!
With this, you can use data from Home Assistant to generate the README.md file in your configuration directory, this can be helpful if you are one of the folks that share their awesome configuration on GitHub.

As an added bonus this can convert your Lovelace configuration if you use the UI to configure Lovelace by parsing creating a shareable/readable ui-lovelace.yaml file.

Why?

I want to share information about my setup, I could manually run templates in the template editor and copy the result to the readme file, but this is Home Assistant and it’s all about automation right?

The repository for this lives on GitHub

custom-components/readme

Issues

If When you experience issues/bugs with this the best way to report them is to open an issue in the repository https://github.com/custom-components/readme/issues, GitHub is AWESOME for tracking/searching issues.

So again, since this is kinda important, If when you experience issues/bugs with this, post them to GitHub, not here.

Issues posted in a forum thread is really, really, really hard to track/follow
The same goes for feature requests.

Your templates

If you create an awesome README with the help of this, please share a link to it in this thread so others can get inspiration

[ludeeus]

I can start out this thread be presenting my own usage :

• The template
• The README.md generated by it

[LUNZ]

hey @ludeeus, thanks for your work here! I think this is an underrated custom component and I’ve used it to generate a cool readme for my github repo.

is there a way with jinja2 templates to create a list of the official integrations in addition to listing the custom components? I see that the frontend creates a list [Developers on the side bar -> click Info at the top -> Scroll down to Integrations] and I’m wondering if this can be captured using jinja2 templates somehow.

Please let me know if I should log something on GitHub instead!

[ludeeus]

please use Github

[sayanova]

Great integration. Can I generate files other than README.md from this integration?

[CM000n (Simon)]

I came across this great custom component today as an addition to my Home Assistant setup. I think it could be quite useful for my documentation of the setup. Thanks @ludeeus.

I’m just wondering who is already using this custom component to create their README files and if they could share their templates? Unfortunately there are no further examples here in the thread yet.

I started “copied with pride” with a config based on an example from ludeus himself.

Here is my template: homeassistant/templates/README.j2 at main · CM000n/homeassistant · GitHub
And here is the resulting README: homeassistant/README.md at main · CM000n/homeassistant · GitHub