特约

就像Feathers本身一样,所有文档都是开源的,并且 可以在GitHub上编辑.如果您看到可以贡献的内容,我们会喜欢您的编辑拉取请求!为方便起见,您可以点击网络文档顶部的*“编辑此页面”*链接.

这些文档都是用 GitHub Flavored Markdown 编写的.如果您使用过GitHub,很可能您以前遇到过它.您可以通过阅读他们的 GFM文档页面 在几分钟内成为专家.

组织文件

You’ll notice that the GitHub Repo is organized in a nice logical folder structure. The first file in each chapter is named as a description of the entire chapter’s topic. For example, the content related to databases is located in api/databases/.

有些章节分为多个部分,以帮助分解内容并使其更容易消化.您可以通过查看 SUMMARY.md 文件轻松查看章节的布局.此约定有助于将章节保存在文件系统中,并且可以直接在github或gitbook上轻松查看.

目录

您可以在 SUMMARY 文件中找到目录.这是一个嵌套的降价链接列表.您只需将文件名(包括扩展名)放在链接目标中即可链接到文件.

简介

这是 root README 文件.它的目的是让读者了解Feathers的电梯,以及我们认为它有用的原因.

发送拉取请求

就是这样了.您进行编辑,保存文件和目录,并向我们发送拉取请求.

享受离线文档

合并编辑后的时刻,它们将自动发布到网络上,作为可下载的PDF, .mobi 文件(兼容Kindle)和ePub文件(兼容iBooks).

分享

We take pride in having great documentation and we are very appreciative of any help we can get. Please, let the world know you’ve contributed to the Feathers Book or give @FeathersJS a shout out on Twitter to let others know about your changes.