You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTENT.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,10 @@
1
1
# Content Guidelines
2
2
3
-
## Table of Contents
4
-
5
-
### Basics
3
+
## Basics
6
4
7
5
Here are some essential markdoc syntax elements with code examples:
8
6
9
-
####Paragraphs and Line Breaks
7
+
### Paragraphs and Line Breaks
10
8
11
9
To create a new paragraph, simply leave a blank line between lines of text.
12
10
@@ -16,7 +14,7 @@ This is the first paragraph.
16
14
This is the second paragraph.
17
15
```
18
16
19
-
####Headers
17
+
### Headers
20
18
21
19
Headers are used to create section titles. Use hashtags (#) for headers, with more hashtags for lower-level headers.
22
20
@@ -34,7 +32,7 @@ Headers can also be given ID's so they can be linked to and are present in the T
34
32
# Header with ID {% #header-with-id %}
35
33
```
36
34
37
-
####Lists
35
+
### Lists
38
36
39
37
Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -.
40
38
@@ -54,7 +52,7 @@ Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -.
54
52
- Cherry
55
53
```
56
54
57
-
####Links
55
+
### Links
58
56
59
57
Create hyperlinks to other web pages or sections within your documentation.
60
58
@@ -63,7 +61,7 @@ Create hyperlinks to other web pages or sections within your documentation.
63
61
[Link to Section](#section-name)
64
62
```
65
63
66
-
####Images
64
+
### Images
67
65
68
66
Embed images using the `` syntax.
69
67
@@ -82,7 +80,7 @@ In most cases, we need images in both light and dark mode such as:
82
80
{% /only_light %}
83
81
```
84
82
85
-
####Code Blocks
83
+
### Code Blocks
86
84
87
85
Format code blocks using triple backticks (```).
88
86
@@ -95,15 +93,15 @@ def hello_world():
95
93
96
94
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).
97
95
98
-
####Inline Code
96
+
### Inline Code
99
97
100
98
Highlight inline code with backticks (`) around the code snippet.
101
99
102
100
```md
103
101
Use the `print()` function to display text.
104
102
```
105
103
106
-
####Emphasis and Strong Text
104
+
### Emphasis and Strong Text
107
105
108
106
Use asterisks (\*) or underscores (\_) for emphasis and double asterisks or underscores for strong text.
109
107
@@ -114,7 +112,7 @@ _Italic Text_ or _Italic Text_
114
112
**Bold Text** or **Bold Text**
115
113
```
116
114
117
-
####Tables
115
+
### Tables
118
116
119
117
Tables allow you to display structured data in your documentation. Use pipes (|) to separate columns and hyphens (-) to define the table header.
120
118
@@ -146,7 +144,7 @@ Alternatively, use markdoc tables.
146
144
{% /table %}
147
145
```
148
146
149
-
####Block Quotes
147
+
### Block Quotes
150
148
151
149
Block quotes are used to emphasize or highlight text. To create a block quote, use the > symbol at the beginning of the quoted text.
152
150
@@ -157,9 +155,9 @@ Block quotes are used to emphasize or highlight text. To create a block quote, u
157
155
158
156
These are the fundamental Markdown syntax elements you'll need to create well-structured and formatted documentation.
159
157
160
-
###Components
158
+
## Components
161
159
162
-
####Tabs
160
+
### Tabs
163
161
164
162
```md
165
163
{% tabs %}
@@ -173,7 +171,7 @@ Lorem ipsum dolor sit amet consectetur.
173
171
{% /tabs %}
174
172
```
175
173
176
-
####Multicode Examples
174
+
### Multicode Examples
177
175
178
176
<pre>
179
177
{% multicode %}
@@ -191,7 +189,9 @@ print('test');
191
189
{% /multicode %}
192
190
</pre>
193
191
194
-
#### Sections
192
+
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).
193
+
194
+
### Sections
195
195
196
196
Use sections when there is a clear step-by-step format to a page. This is used mainly in journey pages and tutorials.
197
197
@@ -209,15 +209,15 @@ Lorem ipsum dolor sit amet consectetur.
209
209
{% /section %}
210
210
```
211
211
212
-
####Info
212
+
### Info
213
213
214
214
```
215
215
{% info title="Public Service Announcement" %}
216
216
Lorem ipsum dolor sit amet consectetur.
217
217
{% /info %}
218
218
```
219
219
220
-
####Icon
220
+
### Icon
221
221
222
222
Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
223
223
@@ -228,7 +228,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
228
228
{% icon icon="github" size="xl" /%}
229
229
```
230
230
231
-
####Icon Image
231
+
### Icon Image
232
232
233
233
Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
234
234
@@ -239,7 +239,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
Copy file name to clipboardExpand all lines: STYLE.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -332,6 +332,13 @@ or a page needs to be sufficiently different from existing pages, follow exisitn
332
332
333
333
If you are proposing a new type of page, discuss an outline in your PR and ask for the Appwrite team's review.
334
334
335
+
### Placeholders
336
+
337
+
Whenever there's a need for a placeholder such as for an ID, use angle brackets (<>) over square brackets ([]) because square brackets can be confused for an array.
0 commit comments