Official home of all documentation content for Streamer.bot and Speaker.bot
Contributions are welcome and encouraged!
Feel free to open an issue to discuss missing information, or just fork and PR ๐
Guidelines: TBA
::tip
This is a cool tip!
::
::warning
Some important info goes here
::
:read-more{to="/path/to/some/other/page"}
::wip
This content is a work in progress
::
Some docs will be automatically built out from YAML frontmatter
All pages should have a title
and description
.
Optionally, if the release version of a feature is known, the version
key should contain the Streamer.bot version.
title: Page Title
description: Some description of this page
version: 0.2.3
The variables
key will automatically build out the Variables section for these pages
twitchService: Chat Client
commonVariables:
- TwitchUser
variables:
- name: viewers
type: number
description: The amount of viewers this raid received
value: 183
Supplemental information can be added to C# methods by adding a markdown file into the api/csharp/_methods directory with the exact same name as the C# Method:
---
description: The primary short description for SomeCsharpMethod
version: 0.2.3
parameters:
- name: data
description: |
Data to be sent to connected clients
JSON must be stringified.
value: '"Hello, world!"'
---
Some extended description information
description
- Short description rendered above the resulting C# code block and included in SEOversion
- Optional value representing the version of Streamer.bot that added this featuredeprecated
- Optional value representing the version of Streamer.bot that deprecated this featureparameters
- Optional of parameter documentationname
- The exact name of this parameter. Must match the name from Streamer.botdescription
- Any additional documentation or info to include with this parameter. Markdown supportedvalue
- An example C# value for this parameter. Will be used within theCPH Example
code block and included in theCopy
functionimport
- Optionally import the parameter fields above from a file in the _parameters dir (see below)
Additionally, parameters information can be shared by referencing the name of any markdown or yaml file in the api/csharp/_parameters directory:
---
parameters:
- import: SomeSharedParameter
---
---
name: my_parameter
description: |
Some long description
With extra info
That would be annoying to include in every file that uses this parameter ๐
value: 0
---