Boilerplate

Here you can find some boilerplate stuff to ease development for a custom-card or to show off an example.

readme.md
collection_template_jekyll
collection_custom_card_jekyll
collection_example_jekyll

Readme

This is the boilerplate template for a custom-cards readme file.

Show the readme template


# Custom-card ""
...

## Credits
Author: xxx - 2021  
Version: 1.0.0  

## Changelog
<details>
<summary>1.0.0</summary>
Initial release
</details>

## Requirements
This card needs the following to function correctly:

<table>
<tr>
<th>Component / card</th>
<th>required</th>
<th>Note</th>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
</table>

## Installation
...  

## Usage

<pre><code class="language-yaml" style="border: 0">
</code></pre>

## Variables
<table>
<tr>
<th>Variable</th>
<th>Example</th>
<th>Required</th>
<th>Explanation</th>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>

## Example
...

<pre><code class="language-yaml" style="border: 0">
</code></pre>

## HomeAssistant
...

## Template code

<pre><code class="language-yaml" style="border: 0">
</code></pre>

## Notes
...

Jekyll boilerplate templates

This wiki/page is generated by Jekyll and hosted on Netlify as part of the repository. You can always take a look at the Jekyll sources in the repo (wiki), to see how this page is build.

To take advantage of the great functions Jekyll provides us with, there are three collections configured, one for templates, one for custom_cards and one for examples. To add to these collections, fill out the boilerplate template and send it to us, eg. by making a PullRequest to the page-repository. With the next page update, the template/custom_card/example will be automatically added. Or you can just post it in the Home Assistant forum thread, and we take care of the rest!

Collection_template_jekyll

Show "collection_template"


---
title: 
name: 
category: 
author: 
explanation: 
image_path: ""
internal: false
variants:
  - name: 
    title: 
    variables:
      - name: 
        type: 
        example: 
        required:  
        explanation: ""
      - name: 
        type: 
        example: 
        required:  
        explanation: ""
    required_cards:
      - name: 
        link: 
      - name: 
        link: 
    yaml: 
    ui: 
    code: 
  - name: 
    title: 
    variables:
      - name: 
        type: 
        example: 
        required:  
        explanation: ""
      - name: 
        type: 
        example: 
        required:  
        explanation: ""
    required_cards:
      - name: 
        link: 
      - name: 
        link: 
    yaml: 
    ui: 
    code: 
---

Collection_custom_card_jekyll

Show "collection_custom_card"


# not redy yet, sorry!

Collection_example_jekyll

Show "collection_example"


# not redy yet, sorry!