mirror of
https://github.com/LukeHagar/website.git
synced 2025-12-06 04:22:07 +00:00
docs: remove unnecessary TOC and fix heading nesting
This commit is contained in:
46
CONTENT.md
46
CONTENT.md
@@ -1,12 +1,10 @@
|
||||
# Content Guidelines
|
||||
|
||||
## Table of Contents
|
||||
|
||||
### Basics
|
||||
## Basics
|
||||
|
||||
Here are some essential markdoc syntax elements with code examples:
|
||||
|
||||
#### Paragraphs and Line Breaks
|
||||
### Paragraphs and Line Breaks
|
||||
|
||||
To create a new paragraph, simply leave a blank line between lines of text.
|
||||
|
||||
@@ -16,7 +14,7 @@ This is the first paragraph.
|
||||
This is the second paragraph.
|
||||
```
|
||||
|
||||
#### Headers
|
||||
### Headers
|
||||
|
||||
Headers are used to create section titles. Use hashtags (#) for headers, with more hashtags for lower-level headers.
|
||||
|
||||
@@ -34,7 +32,7 @@ Headers can also be given ID's so they can be linked to and are present in the T
|
||||
# Header with ID {% #header-with-id %}
|
||||
```
|
||||
|
||||
#### Lists
|
||||
### Lists
|
||||
|
||||
Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -.
|
||||
|
||||
@@ -54,7 +52,7 @@ Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -.
|
||||
- Cherry
|
||||
```
|
||||
|
||||
#### Links
|
||||
### Links
|
||||
|
||||
Create hyperlinks to other web pages or sections within your documentation.
|
||||
|
||||
@@ -63,7 +61,7 @@ Create hyperlinks to other web pages or sections within your documentation.
|
||||
[Link to Section](#section-name)
|
||||
```
|
||||
|
||||
#### Images
|
||||
### Images
|
||||
|
||||
Embed images using the `` syntax.
|
||||
|
||||
@@ -82,7 +80,7 @@ In most cases, we need images in both light and dark mode such as:
|
||||
{% /only_light %}
|
||||
```
|
||||
|
||||
#### Code Blocks
|
||||
### Code Blocks
|
||||
|
||||
Format code blocks using triple backticks (```).
|
||||
|
||||
@@ -95,7 +93,7 @@ def hello_world():
|
||||
|
||||
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).
|
||||
|
||||
#### Inline Code
|
||||
### Inline Code
|
||||
|
||||
Highlight inline code with backticks (`) around the code snippet.
|
||||
|
||||
@@ -103,7 +101,7 @@ Highlight inline code with backticks (`) around the code snippet.
|
||||
Use the `print()` function to display text.
|
||||
```
|
||||
|
||||
#### Emphasis and Strong Text
|
||||
### Emphasis and Strong Text
|
||||
|
||||
Use asterisks (\*) or underscores (\_) for emphasis and double asterisks or underscores for strong text.
|
||||
|
||||
@@ -114,7 +112,7 @@ _Italic Text_ or _Italic Text_
|
||||
**Bold Text** or **Bold Text**
|
||||
```
|
||||
|
||||
#### Tables
|
||||
### Tables
|
||||
|
||||
Tables allow you to display structured data in your documentation. Use pipes (|) to separate columns and hyphens (-) to define the table header.
|
||||
|
||||
@@ -146,7 +144,7 @@ Alternatively, use markdoc tables.
|
||||
{% /table %}
|
||||
```
|
||||
|
||||
#### Block Quotes
|
||||
### Block Quotes
|
||||
|
||||
Block quotes are used to emphasize or highlight text. To create a block quote, use the > symbol at the beginning of the quoted text.
|
||||
|
||||
@@ -157,9 +155,9 @@ Block quotes are used to emphasize or highlight text. To create a block quote, u
|
||||
|
||||
These are the fundamental Markdown syntax elements you'll need to create well-structured and formatted documentation.
|
||||
|
||||
### Components
|
||||
## Components
|
||||
|
||||
#### Tabs
|
||||
### Tabs
|
||||
|
||||
```md
|
||||
{% tabs %}
|
||||
@@ -173,7 +171,7 @@ Lorem ipsum dolor sit amet consectetur.
|
||||
{% /tabs %}
|
||||
```
|
||||
|
||||
#### Multicode Examples
|
||||
### Multicode Examples
|
||||
|
||||
<pre>
|
||||
{% multicode %}
|
||||
@@ -193,7 +191,7 @@ print('test');
|
||||
|
||||
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).
|
||||
|
||||
#### Sections
|
||||
### Sections
|
||||
|
||||
Use sections when there is a clear step-by-step format to a page. This is used mainly in journey pages and tutorials.
|
||||
|
||||
@@ -211,7 +209,7 @@ Lorem ipsum dolor sit amet consectetur.
|
||||
{% /section %}
|
||||
```
|
||||
|
||||
#### Info
|
||||
### Info
|
||||
|
||||
```
|
||||
{% info title="Public Service Announcement" %}
|
||||
@@ -219,7 +217,7 @@ Lorem ipsum dolor sit amet consectetur.
|
||||
{% /info %}
|
||||
```
|
||||
|
||||
#### Icon
|
||||
### Icon
|
||||
|
||||
Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
|
||||
|
||||
@@ -230,7 +228,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
|
||||
{% icon icon="github" size="xl" /%}
|
||||
```
|
||||
|
||||
#### Icon Image
|
||||
### Icon Image
|
||||
|
||||
Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
|
||||
|
||||
@@ -241,7 +239,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
|
||||
{% icon_image src="/icon.png" alt="Icon" size="xl" /%}
|
||||
```
|
||||
|
||||
#### Only Light/Dark Theme
|
||||
### Only Light/Dark Theme
|
||||
|
||||
```
|
||||
{% only_dark %}
|
||||
@@ -252,7 +250,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
|
||||
{% /only_light %}
|
||||
```
|
||||
|
||||
#### Cards
|
||||
### Cards
|
||||
|
||||
We use cards when we reference a list of links for navigation
|
||||
|
||||
@@ -278,7 +276,7 @@ Get started with Appwrite and SvelteKit
|
||||
{% /cards %}
|
||||
```
|
||||
|
||||
#### Cards with icons
|
||||
### Cards with icons
|
||||
|
||||
We use cards when we reference a list of links for navigation, this variation has icons for extra hints visually.
|
||||
|
||||
@@ -296,7 +294,7 @@ Configure FCM for push notification to Android and Apple devices.
|
||||
{% /cards %}
|
||||
```
|
||||
|
||||
#### Accordions
|
||||
### Accordions
|
||||
|
||||
Use accordions to reduce page size and collapse information that's not important when a reader is scrolling the page.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user