Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Elad styles #12

Merged
merged 75 commits into from
Sep 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
398fd5e
Merge branch 'elad-styles' of https://github.com/appwrite/website int…
TorstenDittmann Sep 8, 2023
e0188e3
feat: add markdoc tabs
TorstenDittmann Sep 8, 2023
b430f99
feat: add content guidelines
TorstenDittmann Sep 8, 2023
93075f2
docs: add multicode example
TorstenDittmann Sep 8, 2023
fce00f7
docs: add info and sections
TorstenDittmann Sep 8, 2023
b6a8af1
docs: add spacing to content guidelines
TorstenDittmann Sep 8, 2023
43f78a9
chore: update packages
TorstenDittmann Sep 10, 2023
e2a785f
Merge branch 'elad-styles' of https://github.com/appwrite/website int…
TorstenDittmann Sep 11, 2023
e28cfa7
Community page
elad2412 Sep 11, 2023
ba2a515
Community page
elad2412 Sep 11, 2023
27003b0
feat: references
TorstenDittmann Sep 11, 2023
fab55d3
Merge branch 'elad-styles' of https://github.com/appwrite/website int…
TorstenDittmann Sep 11, 2023
2d14f32
fix: unnecessary loop
TorstenDittmann Sep 11, 2023
116675f
Community page
elad2412 Sep 11, 2023
0c053a3
fix: prerender refs
TorstenDittmann Sep 11, 2023
7fbefe3
add databases
TorstenDittmann Sep 11, 2023
51fb924
Community page
elad2412 Sep 11, 2023
b62dee6
Fix streatch bug
elad2412 Sep 11, 2023
145755a
Remove margin top in list inside list
elad2412 Sep 11, 2023
828f6fc
Merge branch 'elad-styles' of https://github.com/appwrite/website int…
TorstenDittmann Sep 11, 2023
6ec62b8
fix streatching issue
elad2412 Sep 11, 2023
10cce00
community page
elad2412 Sep 11, 2023
1bccd90
community page
elad2412 Sep 11, 2023
4309990
community page
elad2412 Sep 11, 2023
9c71cc6
community page
elad2412 Sep 11, 2023
fd62140
community page
elad2412 Sep 11, 2023
d50e60b
Update spacing according Chen logic design
elad2412 Sep 12, 2023
cae7eee
Update spacing according Chen logic design
elad2412 Sep 12, 2023
998c9d8
Grid Articles
elad2412 Sep 12, 2023
7f6f431
Order List
elad2412 Sep 12, 2023
a70fa10
Merge branch 'elad-styles' of https://github.com/appwrite/website int…
TorstenDittmann Sep 12, 2023
bbfc146
fix: list items
TorstenDittmann Sep 12, 2023
27a5d98
feat: specs
TorstenDittmann Sep 12, 2023
216cec1
Inline Info
elad2412 Sep 12, 2023
79747e7
Typography
elad2412 Sep 12, 2023
301b1c4
Category page
elad2412 Sep 12, 2023
45e217a
fix: alot of stuff
TorstenDittmann Sep 12, 2023
f55541f
fix: users service
TorstenDittmann Sep 12, 2023
d8c1971
fix: databases references
TorstenDittmann Sep 12, 2023
eb025b3
fix: selected lang
TorstenDittmann Sep 12, 2023
ada45d4
fix: refs no scroll
TorstenDittmann Sep 12, 2023
3b67948
code util
TGlide Sep 12, 2023
4f51c58
Main Header
elad2412 Sep 12, 2023
fde9966
Main Header
elad2412 Sep 12, 2023
bb97de3
Main Header
elad2412 Sep 12, 2023
3297548
Contact Us
elad2412 Sep 12, 2023
b36c769
Contact Us
elad2412 Sep 12, 2023
783e95c
Community page
elad2412 Sep 12, 2023
364c6c8
Reference page
elad2412 Sep 12, 2023
cce42b9
Tag
elad2412 Sep 12, 2023
ddbad89
fix: code
TorstenDittmann Sep 13, 2023
3c9fecc
Merge branch 'feat-markdoc' of https://github.com/appwrite/website in…
TorstenDittmann Sep 13, 2023
9932492
Merge branch 'elad-styles' of https://github.com/appwrite/website int…
TorstenDittmann Sep 13, 2023
34be182
fix some stuff
TorstenDittmann Sep 13, 2023
123afc5
remove onetrust
TorstenDittmann Sep 13, 2023
32ec0b7
fix: build
TorstenDittmann Sep 13, 2023
0c5ddc2
About page
elad2412 Sep 13, 2023
10b01d5
Numeric-list
elad2412 Sep 13, 2023
52321ea
Article
elad2412 Sep 13, 2023
536d1c3
feat: add icon component
TorstenDittmann Sep 13, 2023
28ee5ae
fix: some markdoc nodes
TorstenDittmann Sep 13, 2023
0847b8e
fix: less error prone references
TorstenDittmann Sep 13, 2023
dc5ca89
fix: add table width
TorstenDittmann Sep 14, 2023
d3a3cb2
feat: initial work on blog
TorstenDittmann Sep 14, 2023
d34fcdb
feat: http code
TorstenDittmann Sep 15, 2023
2f2e0d9
fix: appwrite/appwrite module name
TorstenDittmann Sep 15, 2023
6b90b95
feat: add 0.15.x
TorstenDittmann Sep 15, 2023
a8ee7d1
fix: add rel attribute to links
TorstenDittmann Sep 15, 2023
babccf2
fix: reduce pages
TorstenDittmann Sep 15, 2023
b59de8a
fix: add versions
TorstenDittmann Sep 16, 2023
9f2b2f1
fix: missing comma
TorstenDittmann Sep 16, 2023
c9ce173
fix: static rendering
TorstenDittmann Sep 16, 2023
b22310a
Merge pull request #6 from appwrite/feat-markdoc
TorstenDittmann Sep 16, 2023
72d8988
Merge branch 'main' of https://github.com/appwrite/website into elad-…
TorstenDittmann Sep 16, 2023
12599fe
fix: add cloud to prerender
TorstenDittmann Sep 16, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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