Skip to content

Commit

Permalink
Merge pull request #12 from appwrite/elad-styles
Browse files Browse the repository at this point in the history
Elad styles
  • Loading branch information
TorstenDittmann authored Sep 16, 2023
2 parents b022fae + 12599fe commit aaa2131
Show file tree
Hide file tree
Showing 85 changed files with 2,781 additions and 9,224 deletions.
186 changes: 186 additions & 0 deletions CONTENT.md
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" /%}
```
29 changes: 17 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,24 @@
},
"devDependencies": {
"@melt-ui/pp": "^0.1.2",
"@melt-ui/svelte": "^0.47.5",
"@playwright/test": "^1.28.1",
"@sveltejs/adapter-auto": "^2.0.0",
"@sveltejs/kit": "^1.20.4",
"@typescript-eslint/eslint-plugin": "^5.45.0",
"@typescript-eslint/parser": "^5.45.0",
"eslint": "^8.28.0",
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-svelte": "^2.30.0",
"@melt-ui/svelte": "^0.47.6",
"@playwright/test": "^1.37.1",
"@sveltejs/adapter-static": "^2.0.3",
"@sveltejs/kit": "^1.24.1",
"@types/markdown-it": "^13.0.1",
"@typescript-eslint/eslint-plugin": "^5.62.0",
"@typescript-eslint/parser": "^5.62.0",
"eslint": "^8.49.0",
"eslint-config-prettier": "^8.10.0",
"eslint-plugin-svelte": "^2.33.1",
"openapi-types": "^12.1.3",
"oslllo-svg-fixer": "^2.2.0",
"prettier": "^2.8.8",
"prettier-plugin-svelte": "^2.10.1",
"sass": "^1.66.1",
"svelte": "^4.2.0",
"svelte-check": "^3.5.1",
"svelte-markdoc-preprocess": "^0.3.1",
"svelte-markdoc-preprocess": "^0.3.2",
"svelte-sequential-preprocessor": "^2.0.1",
"svgtofont": "^3.25.4",
"tslib": "^2.6.2",
Expand All @@ -43,10 +45,13 @@
},
"type": "module",
"dependencies": {
"@apidevtools/swagger-parser": "^10.1.0",
"@appwrite.io/pink": "0.0.7-sl10.0",
"@appwrite.io/repo": "github:appwrite/appwrite",
"@fontsource/inter": "^5.0.8",
"@readme/openapi-parser": "^2.5.0",
"highlight.js": "^11.8.0",
"motion": "^10.16.2"
"markdown-it": "^13.0.1",
"motion": "^10.16.2",
"vite-plugin-dynamic-import": "^1.5.0"
}
}
Loading

0 comments on commit aaa2131

Please sign in to comment.