访问官网
Github
文档Furo
一个简洁可定制的 Sphinx 文档主题。
简介
- 刻意简约 --- 最重要的是内容，而不是周围的框架。
- 响应式 --- 完美适应可用的屏幕空间，适用于各种设备。
- 可定制 --- 更改调色板、字体系列、logo等！
- 易于导航 --- 通过精心设计的侧边栏导航和页面间链接。
- 内容美观 --- 通过清晰的排版和精心设计的元素样式。
- 搜索美观 --- 帮助读者快速找到所需内容。
- 偏向小型文档集 --- 适用于较小的文档集，在侧边栏呈现整个层次结构不会令人不知所措。
快速开始
Furo 在 PyPI 上分发。在您的 Sphinx 项目中使用此主题：
-
在文档的构建环境中安装 Furo。
pip install furo -
在
conf.py中更新html_theme。html_theme = "furo" -
现在您的 Sphinx 文档的 HTML 页面将使用这个主题生成！🎉
更多信息，请访问 Furo 的文档。
贡献
Furo 是一个志愿维护的开源项目，我们欢迎各种形式的贡献。请查看我们的贡献指南以获取更多信息。
致谢
Furo 受到一些优秀技术文档主题的启发（并借鉴了其中的元素）：
- mkdocs-material 用于 MkDocs
- Just the Docs 用于 Jekyll
- GitBook
- pdoc3
我们使用 BrowserStack 在真实设备和浏览器上进行测试。感谢他们对开源项目的支持！
名字的由来
我从家养雪貂的学名 Mustela putorius furo 中提取了这个名字。
雪貂实际上是这个项目的一个很好的精神动物：可爱、小巧、从各处偷走小东西，当你试图让它做它不喜欢的事情时会对你嘶嘶叫。
我计划为这个项目委托设计一个标志（或自己制作一个），包含一只可爱的雪貂。如果您有兴趣，请联系我！
使用者
有人告诉我，提及谁在使用
$东西是推广$东西的好方法。
- urllib3 -- Furo 的第一个采用者
- attrs -- 早期采用者之一！
- pip -- 我为之编写的项目
- Python 开发者指南
- black
许可证
本项目采用 MIT 许可证。
