-
Notifications
You must be signed in to change notification settings - Fork 205
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from appwrite/elad-styles
Elad styles
- Loading branch information
Showing
85 changed files
with
2,781 additions
and
9,224 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,186 @@ | ||
# Content Guidelines | ||
|
||
## Table of Contents | ||
|
||
### Basics | ||
|
||
Here are some essential markdoc syntax elements with code examples: | ||
|
||
#### Paragraphs and Line Breaks | ||
|
||
To create a new paragraph, simply leave a blank line between lines of text. | ||
|
||
```md | ||
This is the first paragraph. | ||
|
||
This is the second paragraph. | ||
``` | ||
|
||
#### Headers | ||
|
||
Headers are used to create section titles. Use hashtags (#) for headers, with more hashtags for lower-level headers. | ||
|
||
```md | ||
# Header 1 | ||
|
||
## Header 2 | ||
|
||
### Header 3 | ||
``` | ||
|
||
Headers can also be given ID's so they can be linked to and are present in the ToC: | ||
|
||
```md | ||
# Header with ID {% #header-with-id %} | ||
``` | ||
|
||
#### Lists | ||
|
||
Create ordered (numbered) and unordered (bulleted) lists using 1., \*, or -. | ||
|
||
**Ordered List**: | ||
|
||
```md | ||
1. First item | ||
2. Second item | ||
3. Third item | ||
``` | ||
|
||
**Unordered List**: | ||
|
||
```md | ||
- Apple | ||
- Banana | ||
- Cherry | ||
``` | ||
|
||
#### Links | ||
|
||
Create hyperlinks to other web pages or sections within your documentation. | ||
|
||
```md | ||
[Google](https://www.google.com) | ||
[Link to Section](#section-name) | ||
``` | ||
|
||
#### Images | ||
|
||
Embed images using the `![alt text](image URL)` syntax. | ||
|
||
```md | ||
![Logo](https://example.com/logo.png) | ||
``` | ||
|
||
#### Code Blocks | ||
|
||
Format code blocks using triple backticks (```). | ||
|
||
<pre> | ||
```python | ||
def hello_world(): | ||
print("Hello, World!") | ||
``` | ||
</pre> | ||
|
||
#### Inline Code | ||
|
||
Highlight inline code with backticks (`) around the code snippet. | ||
|
||
```md | ||
Use the `print()` function to display text. | ||
``` | ||
|
||
#### Emphasis and Strong Text | ||
|
||
Use asterisks (\*) or underscores (\_) for emphasis and double asterisks or underscores for strong text. | ||
|
||
```md | ||
_Italic Text_ or _Italic Text_ | ||
**Bold Text** or **Bold Text** | ||
``` | ||
|
||
#### Tables | ||
|
||
Tables allow you to display structured data in your documentation. Use pipes (|) to separate columns and hyphens (-) to define the table header. | ||
|
||
```md | ||
| Header 1 | Header 2 | Header 3 | | ||
| ------------ | ------------ | ------------ | | ||
| Row 1, Col 1 | Row 1, Col 2 | Row 1, Col 3 | | ||
| Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 | | ||
``` | ||
|
||
#### 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. | ||
|
||
```md | ||
> This is a block quote. | ||
> It can span multiple lines. | ||
``` | ||
|
||
These are the fundamental Markdown syntax elements you'll need to create well-structured and formatted documentation. | ||
|
||
### Components | ||
|
||
#### Tabs | ||
|
||
```md | ||
{% tabs %} | ||
{% tabsitem #js title="Javascript" %} | ||
Lorem ipsum dolor sit amet consectetur. | ||
{% /tabsitem %} | ||
|
||
{% tabsitem #flutter title="Flutter" %} | ||
Lorem ipsum dolor sit amet consectetur. | ||
{% /tabsitem %} | ||
{% /tabs %} | ||
``` | ||
|
||
#### Multicode Examples | ||
|
||
<pre> | ||
{% multicode %} | ||
```js | ||
console.log('test'); | ||
``` | ||
|
||
```php | ||
echo 'test'; | ||
``` | ||
|
||
```dart | ||
print('test'); | ||
``` | ||
{% /multicode %} | ||
</pre> | ||
|
||
#### Sections | ||
|
||
```md | ||
{% section #featured-products-1 step=1 title="Title" %} | ||
Lorem ipsum dolor sit amet consectetur. | ||
{% /section %} | ||
|
||
{% section #featured-products-2 step=2 title="Title" %} | ||
Lorem ipsum dolor sit amet consectetur. | ||
{% /section %} | ||
|
||
{% section #featured-products-3 step=3 title="Title" %} | ||
Lorem ipsum dolor sit amet consectetur. | ||
{% /section %} | ||
``` | ||
|
||
#### Info | ||
|
||
``` | ||
{% info title="Public Service Announcement" %} | ||
Lorem ipsum dolor sit amet consectetur. | ||
{% /info %} | ||
``` | ||
|
||
#### Icon | ||
|
||
``` | ||
{% icon icon="github" /%} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.