Skip to content

Format blueprint descriptions with markdown#8109

Merged
bramkragten merged 1 commit intodevfrom
blueprint-description-markdown
Jan 8, 2021
Merged

Format blueprint descriptions with markdown#8109
bramkragten merged 1 commit intodevfrom
blueprint-description-markdown

Conversation

@thomasloven
Copy link
Copy Markdown
Contributor

Proposed change

Blueprints can get pretty complex. Being able do describe them well would help.

image

Can this be abused? Yes.
Does that make it a bad idea? No.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

blueprint:
  name: Time of Day - Manager
  description: |
    ## Keeps track of Time of Day.

    This requires you to set up an `input_select` [helper entity](/config/helpers) which has the following options:

    * morning
    * day
    * evening
    * night

    Whenever the time of day changes, the event `TOD_UPDATE` is fired. You can use this event as a trigger for your automations, and either look at the `tod` parameter of the event data or the current state of the `input_select` to determine the current Time of Day.

  domain: automation
  input:
...

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue or discussion:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

@bramkragten
Copy link
Copy Markdown
Member

Is the red of the link a theme, or does it miss styling?

@thomasloven
Copy link
Copy Markdown
Contributor Author

That's just my theme for the dev instance.

@bramkragten bramkragten merged commit 2b0f43f into dev Jan 8, 2021
@bramkragten bramkragten deleted the blueprint-description-markdown branch January 8, 2021 11:22
thomasloven added a commit to home-assistant/home-assistant.io that referenced this pull request Jan 8, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Jan 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants