EllieBotDevs/EllieBot-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated marmalade documentation.

Browse source
This commit is contained in:
Toastie 2024-07-22 22:32:15 +12:00
parent e51002a42b
commit 00f595436a
Signed by: toastie_t0ast
GPG key ID: 27F3B6855AFD40A4
3 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
content/Ellie/Marmalade/canary-lifecycle.md
View file

@ -1,5 +1,5 @@
+++ +++
title = "Canary lifecycle!" title = "Canary lifecycle."
description = "This documents the lifecycle of canaries" description = "This documents the lifecycle of canaries"
weight = 3 weight = 3
+++ +++

8
content/Ellie/Marmalade/creating-a-marmalade.md
View file

@ -1,5 +1,5 @@
+++ +++
title = "Creating a marmalade!" title = "Creating a marmalade."
description = "This will hopefully guide you on how to create a marmalade" description = "This will hopefully guide you on how to create a marmalade"
weight = 1 weight = 1
+++ +++
@ -158,7 +158,7 @@ This section will guide you through how to create a simple custom marmalade. You
<ItemGroup> <ItemGroup>
<!-- Base marmalade package. You MUST reference this in order to have a working marmalade --> <!-- Base marmalade package. You MUST reference this in order to have a working marmalade -->
<!-- Also, this package comes from Toastielab, which requires you to have a NuGet.Config file next to your .csproj --> <!-- Also, this package comes from Toastielab, which requires you to have a NuGet.Config file next to your .csproj -->
<PackageReference Include="Ellie.Marmalade" Version="4.3.9"> <PackageReference Include="Ellie.Marmalade" Version="5.*">
<PrivateAssets>all</PrivateAssets> <PrivateAssets>all</PrivateAssets>
</PackageReference> </PackageReference>
@ -182,8 +182,7 @@ This section will guide you through how to create a simple custom marmalade. You
``` ```
- Create a `MyCanary.cs` file and add the following contents - Create a `MyCanary.cs` file and add the following contents
```cs ```cs
using Ellie.Canary; using EllieBot.Marmalade;
using EllieBot;
using Discord; using Discord;
public sealed class MyCanary : Canary public sealed class MyCanary : Canary
@ -202,6 +201,7 @@ public sealed class MyCanary : Canary
} }
``` ```
- Create `res.yml` and `cmds.yml` files with the following contents - Create `res.yml` and `cmds.yml` files with the following contents
`res.yml` `res.yml`
```yml ```yml
marmalade.description: "This is my marmalade's description" marmalade.description: "This is my marmalade's description"

2
content/Ellie/Marmalade/getting-started.md
View file

@ -1,5 +1,5 @@
+++ +++
title = "Getting started!" title = "Getting started."
description = "This guide on getting started with the marmalade system" description = "This guide on getting started with the marmalade system"
weight = 2 weight = 2
+++ +++