https://github.com/appwrite/docs
The official https://appwrite.io/docs documentation 📝
https://github.com/appwrite/docs
hacktoberfest
Last synced: 5 days ago
JSON representation
The official https://appwrite.io/docs documentation 📝
- Host: GitHub
- URL: https://github.com/appwrite/docs
- Owner: appwrite
- License: bsd-3-clause
- Archived: true
- Created: 2021-02-13T14:22:59.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-14T23:10:54.000Z (over 2 years ago)
- Last Synced: 2025-01-15T11:06:56.092Z (11 months ago)
- Topics: hacktoberfest
- Language: HTML
- Homepage:
- Size: 2.04 MB
- Stars: 83
- Watchers: 19
- Forks: 117
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The Appwrite Docs 📝
The official [Appwrite Documentation](https://appwrite.io/docs) source code.
## 🚀 Contributing
1. Clone the repository
2. Update, add, or fix current docs
3. Once content is ready, raise a PR
### Content Guidelines
- Use proper title hierarchy (h1-h6) and valid HTML
- All titles must follow the [Chicago style of headline capitalization](https://capitalizemytitle.com/style/Chicago/)
- External links (not https://appwrite.io) should be opened in a new tab (`target="_blank"`)
- External links should have an HTML attribute of `rel="noopener"`
- All filenames should be dash-based and nested in such a way that makes sense
- All images should be in PNG format and 2600x1400px. Do not include any sensitive data in images. All screenshots of the Appwrite dashboard should support light and dark mode.
- When creating new content or adjusting docs hierarchy, please consult the Appwrite team by opening a Github Issue in this repository
#### Code Examples
Use the following HTML structure to present code examples:
```html
#ruby code here...
```
As of writing this, these are the supported languages for code examples:
* Markup
* CSS
* CLike
* JavaScript
* Bash
* C#
* Dart
* Go
* GraphQL
* HTTP
* Java
* JSON
* Kotlin
* Markup-templating
* PHP
* Powershell
* Python
* Ruby
* Swift
* TypeScript
* YAML
For showing examples in multiple languages use the list structure:
```html
-
Node.js
// node code here...
-
PHP
//php code here..
```
> Don't forget to use proper indenting for all code examples. The indenting of the code examples should be independent from the indentation of the surrounding HTML tags.
#### Notes
Use the following HTML structure to add important notes inside your docs:
```html
Important Message
Message content here.
```
#### Images
Use the following HTML structure to add images. You can also add support for dark and light mode versions (recommended!). If no dark mode is provided, light mode will be the fallback. Don't forget to provide alternative text for user accessibility and a description for each image.
```php
setParam('srcLight', '/images-ee/docs/functions-light.png')
->setParam('srcDark', '/images-ee/docs/functions-dark.png')
->setParam('alt', 'Function settings page.')
->setParam('description', 'Function settings page.')
->render();
?>
```
## 🤘 Support
At any point, if you are stuck, feel free to hop on our [Discord server](https://appwrite.io/discord) to ask questions or seek mentorship!
## Follow Us
Join our growing community around the world! See our official [Blog](https://medium.com/appwrite-io). Follow us on [Twitter](https://twitter.com/appwrite), [Facebook Page](https://www.facebook.com/appwrite.io), [Facebook Group](https://www.facebook.com/groups/appwrite.developers/) , [DEV Community](https://dev.to/appwrite) or join our live [Discord server](https://discord.gg/GSeTUeA) for more help, ideas, and discussions.