Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 3711ea0

Browse files
YizackYizack
committed
docs: prefer Badge component slot for better llms.txt
1 parent d3c8454 commit 3711ea0

File tree

10 files changed

+654
-654
lines changed

10 files changed

+654
-654
lines changed

‎docs/modules.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { VPButton } from 'vitepress/theme-without-fonts'
1010

1111
This is a list of modules available in the MailChannels SDK.
1212

13-
## Email API <Badge type="warning" text="version 0.13.0" />
13+
## Email API <Badge type="warning">version 0.13.0</Badge>
1414

1515
Leverage the power, scale, and reputation of MailChannels to get your mission-critical emails delivered to the inbox reliably, using the same battle-tested infrastructure that today delivers email for more domains than anyone else.
1616

@@ -44,7 +44,7 @@ Leverage the power, scale, and reputation of MailChannels to get your mission-cr
4444

4545
<VPButton href="/modules/suppressions" text="Read documentation" theme="alt" style="text-decoration:none" />
4646

47-
## Inbound API <Badge type="warning" text="version 1.2.0" />
47+
## Inbound API <Badge type="warning">version 1.2.0</Badge>
4848

4949
A cloud-based spam filtering service that protects your users against spam, phishing, and malware.
5050

‎docs/modules/domains.md‎

Lines changed: 188 additions & 188 deletions
Large diffs are not rendered by default.

‎docs/modules/emails.md‎

Lines changed: 117 additions & 117 deletions
Large diffs are not rendered by default.

‎docs/modules/lists.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
outline: deep
33
---
44

5-
# 📋 Lists <Badge type="tip" text="module" /> <Badge type="tip" text="Inbound API" />
5+
# 📋 Lists <Badge type="tip">module</Badge> <Badge type="tip">Inbound API</Badge>
66

77
<!-- #region description -->
88
Manage account-level lists.
99
<!-- #endregion description -->
1010

11-
## Add List Entry <Badge type="info" text="method" />
11+
## Add List Entry <Badge type="info">method</Badge>
1212

1313
Add an entry to an account-level blocklist or safelist.
1414

@@ -41,19 +41,19 @@ const { entry } = await mailchannels.lists.addListEntry({
4141

4242
### Params
4343

44-
- `options` `ListEntryOptions` <Badge type="danger" text="required" />: Add list entry options.
45-
- `listName` `"blocklist" | "safelist" | "blacklist" | "whitelist"` <Badge type="danger" text="required" />: The list to add the item to.
46-
- `item` `string` <Badge type="danger" text="required" />: The item to add to the list. This can be a domain, email address, or IP address.
44+
- `options` `ListEntryOptions` <Badge type="danger">required</Badge>: Add list entry options.
45+
- `listName` `"blocklist" | "safelist" | "blacklist" | "whitelist"` <Badge type="danger">required</Badge>: The list to add the item to.
46+
- `item` `string` <Badge type="danger">required</Badge>: The item to add to the list. This can be a domain, email address, or IP address.
4747

4848
### Response
4949

50-
- `entry` `ListEntry | null` <Badge type="warning" text="nullable" />
51-
- `action` `"blocklist" | "safelist"` <Badge text="guaranteed" />
52-
- `item` `string` <Badge text="guaranteed" />
53-
- `type` `"domain" | "email_address" | "ip_address"` <Badge text="guaranteed" />
54-
- `error` `string | null` <Badge type="warning" text="nullable" />
50+
- `entry` `ListEntry | null` <Badge type="warning">nullable</Badge>
51+
- `action` `"blocklist" | "safelist"` <Badge>guaranteed</Badge>
52+
- `item` `string` <Badge>guaranteed</Badge>
53+
- `type` `"domain" | "email_address" | "ip_address"` <Badge>guaranteed</Badge>
54+
- `error` `string | null` <Badge type="warning">nullable</Badge>
5555

56-
## List Entries <Badge type="info" text="method" />
56+
## List Entries <Badge type="info">method</Badge>
5757

5858
Get account-level list entries.
5959

@@ -80,17 +80,17 @@ const { entries } = await mailchannels.lists.listEntries('safelist')
8080

8181
### Params
8282

83-
- `listName` `"blocklist" | "safelist" | "blacklist" | "whitelist"` <Badge type="danger" text="required" />: The name of the list to fetch.
83+
- `listName` `"blocklist" | "safelist" | "blacklist" | "whitelist"` <Badge type="danger">required</Badge>: The name of the list to fetch.
8484

8585
### Response
8686

87-
- `entries` `ListEntry[]` <Badge text="guaranteed" />
88-
- `action` `"blocklist" | "safelist"` <Badge text="guaranteed" />
89-
- `item` `string` <Badge text="guaranteed" />
90-
- `type` `"domain" | "email_address" | "ip_address"` <Badge text="guaranteed" />
91-
- `error` `string | null` <Badge type="warning" text="nullable" />
87+
- `entries` `ListEntry[]` <Badge>guaranteed</Badge>
88+
- `action` `"blocklist" | "safelist"` <Badge>guaranteed</Badge>
89+
- `item` `string` <Badge>guaranteed</Badge>
90+
- `type` `"domain" | "email_address" | "ip_address"` <Badge>guaranteed</Badge>
91+
- `error` `string | null` <Badge type="warning">nullable</Badge>
9292

93-
## Delete List Entry <Badge type="info" text="method" />
93+
## Delete List Entry <Badge type="info">method</Badge>
9494

9595
Delete item from account-level list.
9696

@@ -123,14 +123,14 @@ const { success } = await mailchannels.lists.deleteListEntry({
123123

124124
### Params
125125

126-
- `options` `ListEntryOptions` <Badge type="danger" text="required" />: Add list entry options.
127-
- `listName` `"blocklist" | "safelist" | "blacklist" | "whitelist"` <Badge type="danger" text="required" />: The name of the list to remove an entry from.
128-
- `item` `string` <Badge type="danger" text="required" />: The list entry which should be removed. This can be a domain, email address, or IP address.
126+
- `options` `ListEntryOptions` <Badge type="danger">required</Badge>: Add list entry options.
127+
- `listName` `"blocklist" | "safelist" | "blacklist" | "whitelist"` <Badge type="danger">required</Badge>: The name of the list to remove an entry from.
128+
- `item` `string` <Badge type="danger">required</Badge>: The list entry which should be removed. This can be a domain, email address, or IP address.
129129

130130
### Response
131131

132-
- `success` `boolean` <Badge text="guaranteed" />: Whether the operation was successful.
133-
- `error` `string | null` <Badge type="warning" text="nullable" />
132+
- `success` `boolean` <Badge>guaranteed</Badge>: Whether the operation was successful.
133+
- `error` `string | null` <Badge type="warning">nullable</Badge>
134134

135135
## Type declarations
136136

0 commit comments

Comments
 (0)