Skip to content

Commit 7d16836

Browse files
committed
docs: remove unnecessary TOC and fix heading nesting
1 parent 1e1a82a commit 7d16836

File tree

1 file changed

+22
-24
lines changed

1 file changed

+22
-24
lines changed

CONTENT.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Content Guidelines
22

3-
## Table of Contents
4-
5-
### Basics
3+
## Basics
64

75
Here are some essential markdoc syntax elements with code examples:
86

9-
#### Paragraphs and Line Breaks
7+
### Paragraphs and Line Breaks
108

119
To create a new paragraph, simply leave a blank line between lines of text.
1210

@@ -16,7 +14,7 @@ This is the first paragraph.
1614
This is the second paragraph.
1715
```
1816

19-
#### Headers
17+
### Headers
2018

2119
Headers are used to create section titles. Use hashtags (#) for headers, with more hashtags for lower-level headers.
2220

@@ -34,7 +32,7 @@ Headers can also be given ID's so they can be linked to and are present in the T
3432
# Header with ID {% #header-with-id %}
3533
```
3634

37-
#### Lists
35+
### Lists
3836

3937
Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -.
4038

@@ -54,7 +52,7 @@ Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -.
5452
- Cherry
5553
```
5654

57-
#### Links
55+
### Links
5856

5957
Create hyperlinks to other web pages or sections within your documentation.
6058

@@ -63,7 +61,7 @@ Create hyperlinks to other web pages or sections within your documentation.
6361
[Link to Section](#section-name)
6462
```
6563

66-
#### Images
64+
### Images
6765

6866
Embed images using the `![alt text](image URL)` syntax.
6967

@@ -82,7 +80,7 @@ In most cases, we need images in both light and dark mode such as:
8280
{% /only_light %}
8381
```
8482

85-
#### Code Blocks
83+
### Code Blocks
8684

8785
Format code blocks using triple backticks (```).
8886

@@ -95,15 +93,15 @@ def hello_world():
9593

9694
Remember to use a specific language label if the code is using an Appwrite SDK. Find the [list of available labels here](https://github.com/appwrite/website/blob/41bb6c71a8647016c88393003d3cf6c4edba1f76/src/lib/utils/references.ts#L26).
9795

98-
#### Inline Code
96+
### Inline Code
9997

10098
Highlight inline code with backticks (`) around the code snippet.
10199

102100
```md
103101
Use the `print()` function to display text.
104102
```
105103

106-
#### Emphasis and Strong Text
104+
### Emphasis and Strong Text
107105

108106
Use asterisks (\*) or underscores (\_) for emphasis and double asterisks or underscores for strong text.
109107

@@ -114,7 +112,7 @@ _Italic Text_ or _Italic Text_
114112
**Bold Text** or **Bold Text**
115113
```
116114

117-
#### Tables
115+
### Tables
118116

119117
Tables allow you to display structured data in your documentation. Use pipes (|) to separate columns and hyphens (-) to define the table header.
120118

@@ -146,7 +144,7 @@ Alternatively, use markdoc tables.
146144
{% /table %}
147145
```
148146

149-
#### Block Quotes
147+
### Block Quotes
150148

151149
Block quotes are used to emphasize or highlight text. To create a block quote, use the > symbol at the beginning of the quoted text.
152150

@@ -157,9 +155,9 @@ Block quotes are used to emphasize or highlight text. To create a block quote, u
157155

158156
These are the fundamental Markdown syntax elements you'll need to create well-structured and formatted documentation.
159157

160-
### Components
158+
## Components
161159

162-
#### Tabs
160+
### Tabs
163161

164162
```md
165163
{% tabs %}
@@ -173,7 +171,7 @@ Lorem ipsum dolor sit amet consectetur.
173171
{% /tabs %}
174172
```
175173

176-
#### Multicode Examples
174+
### Multicode Examples
177175

178176
<pre>
179177
{% multicode %}
@@ -193,7 +191,7 @@ print('test');
193191

194192
Remember to use a specific language label if the code is using an Appwrite SDK. Find the [list of available labels here](https://github.com/appwrite/website/blob/41bb6c71a8647016c88393003d3cf6c4edba1f76/src/lib/utils/references.ts#L26).
195193

196-
#### Sections
194+
### Sections
197195

198196
Use sections when there is a clear step-by-step format to a page. This is used mainly in journey pages and tutorials.
199197

@@ -211,15 +209,15 @@ Lorem ipsum dolor sit amet consectetur.
211209
{% /section %}
212210
```
213211

214-
#### Info
212+
### Info
215213

216214
```
217215
{% info title="Public Service Announcement" %}
218216
Lorem ipsum dolor sit amet consectetur.
219217
{% /info %}
220218
```
221219

222-
#### Icon
220+
### Icon
223221

224222
Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
225223

@@ -230,7 +228,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
230228
{% icon icon="github" size="xl" /%}
231229
```
232230

233-
#### Icon Image
231+
### Icon Image
234232

235233
Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
236234

@@ -241,7 +239,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
241239
{% icon_image src="/icon.png" alt="Icon" size="xl" /%}
242240
```
243241

244-
#### Only Light/Dark Theme
242+
### Only Light/Dark Theme
245243

246244
```
247245
{% only_dark %}
@@ -252,7 +250,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
252250
{% /only_light %}
253251
```
254252

255-
#### Cards
253+
### Cards
256254

257255
We use cards when we reference a list of links for navigation
258256

@@ -278,7 +276,7 @@ Get started with Appwrite and SvelteKit
278276
{% /cards %}
279277
```
280278

281-
#### Cards with icons
279+
### Cards with icons
282280

283281
We use cards when we reference a list of links for navigation, this variation has icons for extra hints visually.
284282

@@ -296,7 +294,7 @@ Configure FCM for push notification to Android and Apple devices.
296294
{% /cards %}
297295
```
298296

299-
#### Accordions
297+
### Accordions
300298

301299
Use accordions to reduce page size and collapse information that's not important when a reader is scrolling the page.
302300

0 commit comments

Comments
 (0)