docs: improve codeblocks

imranbarbhuiya · Jul 31, 2022 · 1f536a0 · 1f536a0
1 parent bd1fa9a
commit 1f536a0
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 16 deletions.
diff --git a/packages/tagscript-plugin-discord/src/lib/Parsers/Cooldown.ts b/packages/tagscript-plugin-discord/src/lib/Parsers/Cooldown.ts
@@ -9,15 +9,15 @@ import { BaseParser, type Context, type IParser } from 'tagscript';
  *
  * @usage
  * ```yaml
- * {cooldown(seconds):response}
+ * { cooldown(seconds): response }
  * ```
  *
  * @alias cd
  *
  * @example
  * ```yaml
- * {cooldown(5):This tag is on cooldown.}
- * {cooldown(5):The tag {name} is on cooldown. Please try again in {retryAfter}.}
+ * { cooldown(5): This tag is on cooldown. }
+ * { cooldown(5): The tag {name} is on cooldown. Please try again in {retryAfter}. }
  * ```
  *
  */

diff --git a/packages/tagscript-plugin-discord/src/lib/Parsers/Embed.ts b/packages/tagscript-plugin-discord/src/lib/Parsers/Embed.ts
@@ -11,30 +11,30 @@ import type { EmbedData, APIEmbed } from 'discord.js';
  *  Using JSON
  *  @usage
  *  ```yaml
- * {embed:json}
+ * { embed: json }
  *  ```
  *  @example
  *  ```yaml
- * {embed:{"title":"Hello!", "description":"This is a test embed."}}
- * {embed:{
- *     "title":"Here's a random duck!",
- *     "image":{"url":"https://random-d.uk/api/randomimg"},
- *     "color":15194415
- * }}
+ * { embed: { "title": "Hello!", "description": "This is a test embed." } }
+ * { embed: {
+ *     "title": "Here's a random duck!",
+ *     "image": { "url": "https://random-d.uk/api/randomimg" },
+ *     "color": 15194415
+ * } }
  * ```
  *
  *  Using properties
  *  @usage
  * ```yaml
- * {embed(property):value}
+ * { embed(property): value }
  * ```
  *
  * @example
  * ```yaml
- * {embed(color):0x37b2cb}
- * {embed(title):Rules}
- * {embed(description):Follow these rules to ensure a good experience in our server!}
- * {embed(field):Rule 1|Respect everyone you speak to.|false}
+ * { embed(color): 0x37b2cb }
+ * { embed(title): Rules }
+ * { embed(description): Follow these rules to ensure a good experience in our server! }
+ * { embed(field): Rule 1|Respect everyone you speak to.|false }
  * ```
  *
  * @see The return type depends on user's input. So it might not be `EmbedData | APIEmbed`. So use a typeguard to check.

diff --git a/typedoc.json b/typedoc.json
@@ -7,5 +7,6 @@
 	"name": "TagScript",
 	"out": "./docs/",
 	"tsconfig": "./tsconfig.base.json",
-	"externalLinkPath": "scripts/externalConfig.js"
+	"externalLinkPath": "scripts/externalConfig.js",
+	"hideGenerator": true
 }