Modèle de documentation

Needs translation

Purpose

A brief description of the component.

Use when

  • Use case 1
  • Use case 2
  • Use case 3

Do not use when

  • Use case 1
  • Use case 2
  • Use case 3

Working example

Link to a working example

How to implement

  1. Step 1
  2. Step 2 
    Example code
  3. Step 3 
    Example of multi-line code
Example of multi-line code
Example of multi-line code
  4. Step 4

Configuration options

Document the public configuration options that can be used by implementers or developers.

Option Description How to configure Values
Option 1 Brief description of the option How to configure the option
Value 1 (default):
Brief description
Value 2:
Brief description
Value 3:
Brief description
Option 2 Brief description of the option How to configure the option
Value 1 (default):
Brief description
Value 2:
Brief description
Value 3:
Brief description

Events

Document the public events that can be used by implementers or developers.

Event Trigger What it does
Event 1 When the event is triggered and how to trigger it manually (where supported) Brief description of what it does.
Event 2 When the event is triggered and how to trigger it manually (where supported) Brief description of what it does.

Source code

Link to the folder on GitHub containing the files for the component

Date de modification :