README

🚀 贡献

克隆仓库
更新、添加或修复当前文档
内容准备就绪后，提交一个PR

内容指南

使用正确的标题层级（h1-h6）和有效的HTML
所有标题都必须遵循芝加哥标题大写风格
外部链接（不是 https://appwrite.io）应在新标签页中打开（target="_blank"）
外部链接应具有HTML属性 rel="noopener"
所有文件名都应基于破折号，并嵌套得有意义
所有图像都应使用PNG格式，尺寸为2600x1400px。不要在图像中包含任何敏感数据。所有Appwrite仪表板的截图都应支持浅色和深色模式。
在创建新内容或调整文档层次结构时，请通过在此存储库中创建Github Issue来咨询Appwrite团队

代码示例

使用以下HTML结构来展示代码示例

<div class="ide margin-top-small" data-lang="ruby" data-lang-label="Ruby SDK">
    <pre class="line-numbers"><code class="prism language-ruby" data-prism>#ruby code here...</code></pre>
</div>

撰写本文时，以下为支持代码示例的语言

标记
CSS
CLike
JavaScript
Bash
C#
Dart
Go
GraphQL
HTTP
Java
JSON
Kotlin
标记模板
PHP
Powershell
Python
Ruby
Swift
TypeScript
YAML

要显示多语言示例，请使用列表结构

<ul class="phases clear" data-ui-phases>
    <li>
        <h3>Node.js</h3>
        <div class="ide margin-top-small" data-lang="nodejs" data-lang-label="Node.js SDK">
            <pre class="line-numbers"><code class="prism language-javascript" data-prism>// node code here...</code></pre>
        </div>
    </li>
    <li>
        <h3>PHP</h3>

        <div class="ide margin-top-small" data-lang="php" data-lang-label="PHP SDK">
            <pre class="line-numbers"><code class="prism language-php" data-prism>//php code here..</code></pre>
        </div>
    </li>
</ul>

不要忘记为所有代码示例使用适当的缩进。代码示例的缩进应独立于周围HTML标签的缩进。

注意事项

使用以下HTML结构在文档中添加重要说明

<div class="notice">
  <h2>Important Message</h2>
  <p>Message content here.</p>
</div>

图像

使用以下HTML结构添加图像。您还可以添加浅色和深色模式的版本（推荐！）如果未提供深色模式，则浅色模式将是回退选项。不要忘记为用户可访问性提供替代文本并为每张图像提供描述。

<?php
$image = new View(__DIR__.'/../general/image.phtml');
    echo $image
        ->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();
?>

🤘 支持

在任何时候，如果您遇到困难，随时可以跳到我们的 Discord服务器提问或寻求指导！

关注我们

加入我们全球不断增长的社区！查看我们的官方博客。关注我们的 Twitter，Facebook 页面，Facebook 群组，DEV 社区或加入我们的实时 Discord 服务器以获取更多帮助、想法和讨论。

appwrite / docs

维护者

详情