just the docs

只是文档

一个现代、高度可定制且响应灵敏的 Jekyll 主题，用于带有内置搜索的文档。
轻松托管在 GitHub Pages 上，几乎没有依赖项。

看看它的实际效果！

各种 Just the Docs 功能的视频演练

只是文档功能演练.mp4

安装

使用模板

Just the Docs 模板提供了创建使用 Just the Docs 主题的新网站的最简单、最快且最简单的方法。要开始创建网站，只需单击“使用模板”！

注意：要使用该主题，您不需要克隆或分叉 Just the Docs 存储库！仅当您打算在本地浏览主题文档、为主题的开发做出贡献或基于 Just the Docs 开发新主题时，才应该这样做。

您可以轻松地将模板创建的站点设置为在 GitHub Pages 上发布 - 模板自述文件解释了如何执行此操作以及其他详细信息。

如果您的计算机上安装了 Jekyll，您还可以在本地构建并预览创建的站点。这使您可以在提交更改之前对其进行测试，并避免等待 GitHub Pages。 ¹您将能够将本地构建部署到 GitHub Pages 以外的平台。

更具体地说，创建的网站：

• 使用基于 gem 的方法，即使用Gemfile并加载just-the-docs gem
• 使用 GitHub Pages / Actions 工作流程在 GitHub Pages 上构建和发布网站

除此之外，您可以根据自己的喜好自由定制使用模板创建的网站。您可以轻松更改just-the-docs和它使用的 Jekyll 的版本，以及添加更多插件。

使用 RubyGems

或者，您可以将主题安装为 Ruby Gem，而无需创建新站点。

将此行添加到 Jekyll 站点的Gemfile中：

 gem "just-the-docs"

并将此行添加到 Jekyll 站点的_config.yml中：

 theme : just-the-docs

然后执行：

 $ bundle

或者自己安装：

 $ gem install just-the-docs

或者，您可以在开发站点时在 Docker 内运行它

 $ docker-compose up

用法

查看文档以获取使用信息。

贡献

欢迎在 GitHub 上提交错误报告、新功能提案和拉取请求：https://github.com/just-the-docs/just-the-docs。该项目旨在成为一个安全、温馨的协作空间，贡献者应遵守贡献者契约行为准则。

提交代码更改：

• 使用适当的模板提交激发更改的问题
• 与其他用户和维护者讨论建议的更改
• 打开拉取请求
• 确保所有 CI 测试通过
• 提供检查更改效果的说明
• 等待代码审查

本主题设计开发原则：

1. 尽可能少的依赖
2. 无需构建脚本
3. 一流的移动体验
4. 让内容闪闪发光

发展

要设置您的环境来开发此主题：fork此存储库，从根目录运行bundle install 。

包含 VSCode 的现代开发容器配置。

您的主题设置就像普通的 Jekyll 网站一样！要测试您的主题，请运行bundle exec jekyll serve并在http://localhost:4000打开浏览器。这将使用您的主题启动 Jekyll 服务器。像平常一样添加页面、文档、数据等来测试主题的内容。当您修改主题和内容时，您的网站将重新生成，刷新后您应该会在浏览器中看到更改，就像平常一样。

当这个主题发布时，只有 Git 跟踪的_layouts 、 _includes和_sass中的文件才会包含在 gem 中。

执照

该主题根据 MIT 许可证条款作为开源提供。

脚注

1. 将更改推送到 GitHub 后，最多可能需要 10 分钟才能发布对网站的更改。 ↩