跳至主要内容

Electron 文档

·阅读时间：4 分钟
jlord
jlord

本周，我们在 electronjs.org 上为 Electron 的文档提供了一个归宿。您可以访问 /docs/latest 以获取最新版本的文档。我们还将保留旧版文档，因此您可以访问 /docs/vX.XX.X 以获取与您使用的版本相对应的文档。

您可以访问 /docs 以查看可用的版本，或访问 /docs/all 以在一个页面上查看最新版本的文档（非常适合使用 cmd + f 进行搜索）。

如果您想为文档内容做出贡献，您可以在 Electron 存储库 中进行操作，文档就是从这里获取的。我们会在每个次要版本发布时获取它们，并将它们添加到 Electron 网站存储库 中，该存储库使用 Jekyll 制作。

如果您有兴趣了解更多关于我们如何将文档从一个存储库拉取到另一个存储库的信息，请继续阅读。否则，享受 文档！

技术细节​

我们正在保留 Electron 核心存储库中的文档，保持原样。这意味着 electron/electron 将始终拥有最新版本的文档。当发布 Electron 的新版本时，我们会将其复制到 Electron 网站存储库 electron/electronjs.org 上。

script/docs​

要获取文档，我们运行一个带有命令行界面的 脚本：script/docs vX.XX.X，带有或不带 --latest 选项（取决于您要导入的版本是否为最新版本）。我们 用于获取文档的脚本 使用了一些有趣的 Node 模块

测试 帮助我们了解所有部分是否按预期落地。

Jekyll​

Electron 网站是一个 Jekyll 网站，我们利用了 集合 功能来处理文档，其结构如下所示

electron.atom.io
└── _docs
    ├── latest
    ├── v0.27.0
    ├── v0.26.0
    ├── so on
    └── so forth

前置 matter​

为了让 Jekyll 呈现每个页面，它至少需要一个空的 front matter。我们将对所有页面使用 front matter，因此在流式输出 /docs 目录时，我们会检查文件是否为 README.md 文件（在这种情况下，它将接收一种 front matter 配置），或者它是否为任何其他具有 markdown 扩展名的文件（在这种情况下，它将接收略微不同的 front matter）。

每个页面都会收到这组 front matter 变量

---
version: v0.27.0
category: Tutorial
title: 'Quick Start'
source_url: 'https://github.com/electron/electron/blob/master/docs/tutorial/quick-start.md'
---

README.md 会获得额外的 permalink，以便其 URL 具有 index.html 的通用根，而不是笨拙的 /readme/。

permalink: /docs/v0.27.0/index.html

配置和重定向​

在站点的 _config.yml 文件中，每次在获取文档时使用 --latest 标志时，都会设置一个变量 latest_version。我们还会添加已添加到站点的所有版本的列表，以及我们希望用于整个文档集合的 permalink。

latest_version: v0.27.0
available_versions:
  - v0.27.0
collections:
  docs: { output: true, permalink: '/docs/:path/' }

我们站点根目录中的 latest.md 文件为空，除了这个 front matter，它允许用户通过访问此 URL 查看最新版本文档的索引（即 README）：electron.atom.io/docs/latest，而不是使用最新的版本号（尽管您也可以这样做）。

---
permalink: /docs/latest/
redirect_to: /docs/{{ site.data.releases[0].version }}
---

布局​

在 docs.html 布局模板中，我们使用条件语句来显示或隐藏标题和面包屑中的信息。

{% raw %} {% if page.category != 'ignore' %}
<h6 class="docs-breadcrumb">
  {{ page.version }} / {{ page.category }} {% if page.title != 'README' %} / {{
  page.title }} {% endif %}
</h6>
{% endif %} {% endraw %}

要创建一个显示可用版本的页面，我们只需在站点根目录中的一个文件 versions.md 上循环遍历我们配置中的列表。此外，我们还为此页面提供了一个 permalink：/docs/

{% raw %} {% for version in site.available_versions %} - [{{ version
}}](/docs/{{ version }}) {% endfor %} {% endraw %}

希望您喜欢这些技术细节！如果您有兴趣了解有关使用 Jekyll 创建文档网站的更多信息，请查看 GitHub 的文档团队如何发布 GitHub 的文档到 Jekyll 上。