LukeParke/website
1
0
Fork 0
mirror of https://github.com/LukeHagar/website.git synced 2025-12-06 04:22:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove unnecessary TOC and fix heading nesting

Browse Source
This commit is contained in:
Steven Nguyen
2025-05-22 16:53:26 -07:00
parent 1e1a82ae39
commit 7d168369d9
1 changed files with 22 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
CONTENT.md
View File

@@ -1,12 +1,10 @@
# Content Guidelines # Content Guidelines
## Table of Contents ## Basics
### Basics
Here are some essential markdoc syntax elements with code examples: 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. 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. 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. 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 %} # Header with ID {% #header-with-id %}
``` ```
#### Lists ### Lists
Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -. 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 - Cherry
``` ```
#### Links ### Links
Create hyperlinks to other web pages or sections within your documentation. 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) [Link to Section](#section-name)
``` ```
#### Images ### Images
Embed images using the `![alt text](image URL)` syntax. Embed images using the `![alt text](image URL)` syntax.
@@ -82,7 +80,7 @@ In most cases, we need images in both light and dark mode such as:
{% /only_light %} {% /only_light %}
``` ```
#### Code Blocks ### Code Blocks
Format code blocks using triple backticks (```). 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). 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. 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. 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. 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** **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. 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 %} {% /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. 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. These are the fundamental Markdown syntax elements you'll need to create well-structured and formatted documentation.
### Components ## Components
#### Tabs ### Tabs
```md ```md
{% tabs %} {% tabs %}
@@ -173,7 +171,7 @@ Lorem ipsum dolor sit amet consectetur.
{% /tabs %} {% /tabs %}
``` ```
#### Multicode Examples ### Multicode Examples
<pre> <pre>
{% multicode %} {% 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). 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. 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 %} {% /section %}
``` ```
#### Info ### Info
``` ```
{% info title="Public Service Announcement" %} {% info title="Public Service Announcement" %}
@@ -219,7 +217,7 @@ Lorem ipsum dolor sit amet consectetur.
{% /info %} {% /info %}
``` ```
#### Icon ### Icon
Available sizes are `s`, `m`, `l` and `xl`. Default: `s`. 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 icon="github" size="xl" /%}
``` ```
#### Icon Image ### Icon Image
Available sizes are `s`, `m`, `l` and `xl`. Default: `s`. 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" /%} {% icon_image src="/icon.png" alt="Icon" size="xl" /%}
``` ```
#### Only Light/Dark Theme ### Only Light/Dark Theme
``` ```
{% only_dark %} {% only_dark %}
@@ -252,7 +250,7 @@ Available sizes are `s`, `m`, `l` and `xl`. Default: `s`.
{% /only_light %} {% /only_light %}
``` ```
#### Cards ### Cards
We use cards when we reference a list of links for navigation We use cards when we reference a list of links for navigation
@@ -278,7 +276,7 @@ Get started with Appwrite and SvelteKit
{% /cards %} {% /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. 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 %} {% /cards %}
``` ```
#### Accordions ### Accordions
Use accordions to reduce page size and collapse information that's not important when a reader is scrolling the page. Use accordions to reduce page size and collapse information that's not important when a reader is scrolling the page.