为开源项目建立技术文档静态网站

无需加好友免费技术支持

Eleventy 是一个基于 JavaScript 的 Jekyll 和 Hugo 构建静态网站的替代品。

静态网站生成器是基于原始数据和一组模板生成的完整静态 HTML 网站工具。它可以自动完成一个单一的工具 HTML 页面编码任务，并准备好为用户服务。 HTML 页面是提前建立的，它们在用户浏览器中加载得非常快。

静态网站对文档也很友好，因为静态网站容易扩展，是生成、维护和部署项目文档的简单方法。由于这些原因，企业经常使用它们来记录应用程序编程界面 （API）、数据库模式等信息。文档是软件开发、设计等技术的重要组成部分。所有代码库都需要一定形式的文档，从简单的方式选择范围 README 到完整的文档。

Eleventy（11ty）它是一个简单的静态网站生成器Jekyll和Hugo替代品。它是用的 JavaScript 它将一个（不同类型）的模板目录转换为 HTML。它也是开源的，在 MIT 许可发布。

Eleventy 可以与 HTML、Markdown、Liquid、Nunjucks、Handlebars、Mustache、EJS、Haml、Pug 和 JavaScript Template Literals 协同工作。

其特点包括：

易于设置支持多种模板语言（如 Nunjucks、HTML、JavaScript、Markdown、Liquid）可定制基于 JavaScript，许多网络开发者都熟悉这一点，新用户也很容易学习

Eleventy 需要 Node.js。在 Linux 你可以用你的包管理器安装 Node.js：

如果你的包管理器没有 Node.js，或者你不在 Linux 上，你可以从 Node.js 安装网站。

Node.js 安装后，用它来安装 Eleventy：

这就完成了！

现在可以开始用了 Eleventy 建立你的静态文档网站。以下步骤需要遵循。

1、创建一个 package.json 文件要将 Eleventy 在你的项目中安装，你需要一个 文件：

2、将 Eleventy 安装到 package.json 中安装 Eleventy 并将其保存到您的项目中 中。运行：

3、运行 Eleventy使用 命令运行您的本地项目 Eleventy 版本。确认安装完成后，尝试运行 Eleventy：

4.创建一些模板，运行两个命令来创建两个新的模板文件(一个 HTML 和一个 Markdown 文件）：

在输出文件夹中编译当前目录或子目录中的任何内容模板(默认为 ）。

运行 启动开发网络服务器。

在你的网络浏览器中打开 ，看你的 Eleventy 输出。

然后把 文件上传到你的 Web 服务器，向世界发布你的网站。

Eleventy 它是一个静态网站生成器，易于使用，有模板和主题。如果您已经在您的开发过程中使用它 Node.js，Eleventy 可能比 Jekyll 或 Hugo 更自然。它可以快速提供好的结果，避免复杂的网站设计和维护。了解更多关于使用的信息 Eleventy 请仔细阅读其文档。

本文基于 为开源项目建立技术文档静态网站，首次发布 Nwokocha Wisdom Maduabuchi 的 Medium 上，经授权转载。

via:

作者：Nwokocha Wisdom选题：lujun9972译者：geekpi校对：wxy

本文由 LCTT原创编译，Linux推出中国荣誉