Skip to content

Latest commit

 

History

History
222 lines (173 loc) · 9.35 KB

README.zh-cn.md

File metadata and controls

222 lines (173 loc) · 9.35 KB
Raw

DoIt 主题 | Hugo

English README | 简体中文说明

DoIt 是一个简洁、优雅且高效的 Hugo 博客主题。

它的原型基于 LoveIt 主题, LeaveIt 主题 和 KeepIt 主题。

DoIt 主题继承了这些主题的优秀功能，并在此基础上添加了新的功能与优化，请阅读 为什么选择 DoIt来了解更多。

DoIt 主题的目标是创建一个功能强大且易于使用的 Hugo 主题，您可以全心关注于创作博客内容，而无需担心复杂的技术细节，just** do it**。

立即开始

前往这篇文档，阅读关于安装与使用的详细指南。

从 LoveIt 迁移

如果你现在正在使用 LoveIt 主题，你可以很容易地迁移至 DoIt。

你可以将这个主题仓库添加为你的网站目录的子模块。

git submodule add https://github.com/HEIGE-PCloud/DoIt.git themes/DoIt

之后，你可以通过这条命令来将主题更新至最新版本。

git submodule update --remote --merge

或者，你可以下载主题的最新版本.zip 文件并且解压放到themes目录。（不推荐，这个主题会被频繁更新，发行版中可能包含过时的文件。）

接着，前往 config.toml 并将默认主题更改为 DoIt。

- theme = "LoveIt"
+ theme = "DoIt"

这样就完成了迁移工作，现在一切准备就绪 🎉

DoIt 主题增加了许多新的功能与配置项，查看变更日志与文档来了解更多。

主题预览

为了直观地浏览主题特性，这里有一个基于 DoIt 主题渲染的 预览网站。

为什么选择 DoIt

  • 自定义标题栏
  • 自定义CSS 样式
  • 焕然一新的主页，已经兼容最新版 Hugo
  • 大量的样式细节调整，包括颜色、字体大小、边距、代码预览样式
  • 可读性更强的深色模式
  • 一些美观的 CSS 动画
  • 易用和自动展开的文章目录
  • 支持更多的社交链接、网站分享和评论系统
  • 支持基于 algolia 或 Fuse.js 的搜索
  • 一键复制代码到剪贴板
  • 支持基于 Font Awesome 图标的扩展 Markdown 语法
  • 支持上标注释的扩展 Markdown 语法
  • 支持分数的扩展 Markdown 语法
  • 支持基于 KaTeX 的数学公式
  • 支持基于 mermaid 的图表生成功能
  • 支持基于 ECharts 的交互式数据可视化生成功能
  • 支持基于 Mapbox GL JS 的 Mapbox 地图显示功能
  • 支持基于 APlayer 和 MetingJS 的内嵌音乐播放器
  • 支持内嵌 Bilibili 视频
  • 支持多种注释的 shortcode
  • 支持自定义样式的 shortcode
  • 支持所有第三方库的 CDN
  • 支持多作者分类
  • ...

所以，如果你更偏好 DoIt 主题的设计语言和自由度，如果你想便捷地使用扩展的 Font Awesome 图标，如果你想在文章内嵌数学公式、流程图、音乐或是 Bilibili 视频， 那么，DoIt 主题可能是更适合你。

特性

性能和 SEO

外观和布局

  • 响应式布局
  • 浅色/深色/黑色 主题模式
  • 全局一致的设计语言
  • 支持分页
  • 易用和自动展开的文章目录
  • 支持多语言和国际化
  • 美观的 CSS 动画
  • 全新的为宽屏适配的页面布局
  • 全新的PWA应用适配

社交和评论系统

扩展功能

  • 支持基于 algolia 或 Fuse.js 的搜索
  • 支持 Twemoji
  • 支持代码高亮
  • 一键复制代码到剪贴板
  • 支持基于 lightgallery.js 的图片画廊
  • 支持 Font Awesome 图标的扩展 Markdown 语法
  • 支持上标注释的扩展 Markdown 语法
  • 支持分数的扩展 Markdown 语法
  • 支持基于 KaTeX 的数学公式
  • 支持基于 mermaid 的图表 shortcode
  • 支持基于 ECharts 的交互式数据可视化 shortcode
  • 支持基于 Mapbox GL JS 的 Mapbox shortcode
  • 支持基于 APlayer 和 MetingJS 的音乐播放器 shortcode
  • 支持 Bilibili 视频 shortcode
  • 支持多种注释的 shortcode
  • 支持自定义样式的 shortcode
  • 支持自定义脚本的 shortcode
  • 支持友链的 shortcode
  • 支持基于 TypeIt 的打字动画 shortcode
  • 支持基于原生CSS的滚动动画
  • 支持基于 cookieconsent 的 Cookie 许可横幅
  • 支持本地缓存远程图床图片
  • ...

文档

在本地构建文档:

hugo server --source=exampleSite

多语言和国际化

DoIt 支持下列语言:

  • 英语
  • 简体中文
  • 法语
  • 波兰语
  • 巴西葡萄牙语
  • 意大利语
  • 西班牙语
  • 德语
  • 塞尔维亚语
  • 俄语
  • 罗马尼亚语
  • 越南语
  • 贡献一种新的语言

语言兼容性

路线图

变更日志

问题、想法、 bugs 和 PRs

所有的反馈都是欢迎的！详见 issue tracker。

许可协议

DoIt 根据 MIT 许可协议授权。 更多信息请查看 LICENSE 文件。

DoIt 主题中用到了以下项目，感谢它们的作者：

作者

PCloud