跳到主要内容

Electron 文档

·4 分钟阅读
jlord
jlord

本周，我们将 Electron 的文档托管到了 electronjs.org。您可以访问 /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 站点，我们利用 Collections 功能来组织文档，结构如下

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

Front 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 electron.atom.io/docs/latest 查看最新版本文档的索引（也称 README），而不是具体使用最新的版本号（尽管您也可以这样做）。

---
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 文档团队如何使用 Jekyll 发布 GitHub 文档。