From e287b3b848237f3fe51bad7ee77052930199ab35 Mon Sep 17 00:00:00 2001 From: liuyib <1656081615@qq.com> Date: Sun, 15 Sep 2019 14:28:12 +0800 Subject: [PATCH] docs: Update docs --- docs/zh-CN/advanced/advanced-setting.md | 22 ++++++++++++++----- docs/zh-CN/advanced/assist.md | 10 ++++----- docs/zh-CN/advanced/third-part.md | 21 ++++++++++-------- docs/zh-CN/guide/primary-setting.md | 12 +++++++--- layout/_partials/analytics/busuanzi.pug | 4 ++-- .../components/analytics/busuanzi.styl | 19 ++++++---------- 6 files changed, 51 insertions(+), 37 deletions(-) diff --git a/docs/zh-CN/advanced/advanced-setting.md b/docs/zh-CN/advanced/advanced-setting.md index b9462f8..734fbc9 100644 --- a/docs/zh-CN/advanced/advanced-setting.md +++ b/docs/zh-CN/advanced/advanced-setting.md @@ -54,7 +54,7 @@ Hexo 会帮你记录文件的更新日期，所以一般不需要手动指定 `u - `comments` - 是否开启评论功能 - 在 Stun 主题中，如果你启用了某个评论系统，默认是对所有通过 markdown 文件生成的页面（除首页，归档页，单个分类页，单个标签页以外的所有页面）生效。因此，你可以使用该属性单独设置某个页面 / 文章是否启用评论。 + 在 Stun 主题中，如果你启用了某个评论系统，默认是对所有通过 Markdown 文件生成的页面（除首页，归档页，单个分类页，单个标签页以外的所有页面）生效。因此，你可以使用该属性单独设置某个页面 / 文章是否启用评论。 - `permalink` - 覆盖文章网址 @@ -89,7 +89,7 @@ Hexo 会帮你记录文件的更新日期，所以一般不需要手动指定 `u 那么它会被解析为 `foo,bar,baz`，也就是一个标签。 -- `layout` - 是否处理 markdown 源文件 +- `layout` - 是否处理 Markdown 源文件 如果你不想你的文章或页面被处理，可以将 `Front-Matter` 中的 `layout` 设为 `false`。例如： @@ -97,7 +97,7 @@ Hexo 会帮你记录文件的更新日期，所以一般不需要手动指定 `u ![](https://raw.githubusercontent.com/liuyib/picBed/master/hexo-theme-stun/doc/20190820175118.png) - > 可以看到，设置了 `layout: false` 后，不对 markdown 文件做任何处理，直接将文件的原始内容显示出来。 + > 可以看到，设置了 `layout: false` 后，不对 Markdown 文件做任何处理，直接将文件的原始内容显示出来。 没有设置 `layout: false` 的默认情况下或设置了 `layout: true`： @@ -286,6 +286,12 @@ creative_commons: ![](https://raw.githubusercontent.com/liuyib/picBed/master/hexo-theme-stun/doc/20190619210339.png) +你可以在文章 Markdown 源文件中的 `Front-Matter` 里，设置 `copyright: false` 来指定某篇文章不启用知识共享许可协议。 + +::: warning 注意 +如果主题配置文件中没有启用 `creative_commons`，那么单独设置文章 `copyright: true` 是没有效果的。 +::: + ## 返回顶部 修改主题配置文件： @@ -381,7 +387,7 @@ sidebar: # 侧边栏位置，可选值有：left 或 right position: right # 侧边栏距离顶部的距离（只支持 px 单位） - offsetTop: 20px + offsetTop: 30px # 是否显示水平分割线 horizon_line: false # 侧边栏宽度（建议宽度：240px ~ 340px） @@ -403,12 +409,16 @@ toc: # 是否始终展开所有文章目录。true：始终展开，false：当文章中对应的标题到达顶部时自动展开 expand_all: false # 生成目录时，解析 h 标签的最大深度 - # 你可以在文章的 markdown 源文件的 Front-Matter 中，通过添加 `toc_max_depth` 属性， + # 你可以在文章 Markdown 源文件的 Front-Matter 中，通过添加 `toc_max_depth` 属性， # 来指定某篇文章生成目录时，解析 h 标签的最大深度 max_depth: 4 ``` -其中 `expand_all` 。可以在文章的 markdown 源文件中的 `Front-Matter` 里，指定 `toc: true / false` 来设置某篇文章是否启用目录。 +其中 `expand_all` 。在文章 Markdown 源文件中的 `Front-Matter` 里，设置 `toc: false` 来指定某篇文章不启用目录。 + +::: warning 注意 +如果主题配置文件中没有启用 `toc`，那么单独设置文章 `toc: true` 是没有效果的。 +::: ## 订阅设置 diff --git a/docs/zh-CN/advanced/assist.md b/docs/zh-CN/advanced/assist.md index 321fb55..13fc1e1 100644 --- a/docs/zh-CN/advanced/assist.md +++ b/docs/zh-CN/advanced/assist.md @@ -30,7 +30,7 @@ shortcuts: ## 标签插件 -该功能相当于 Hexo 对 markdown 语法的一种扩展，用于快速在文章中插入指定的内容。你可以访问[这里](https://hexo.io/zh-cn/docs/tag-plugins)查看 Hexo 都支持哪些标签插件。 +该功能相当于 Hexo 对 Markdown 语法的一种扩展，用于快速在文章中插入指定的内容。你可以访问[这里](https://hexo.io/zh-cn/docs/tag-plugins)查看 Hexo 都支持哪些标签插件。 Hexo 主题一般都会扩展一些自己特有的标签插件，在这方面做得最好的是 NexT 主题，你可以查看 NexT 主题所特有的标签插件：[https://theme-next.org/docs/tag-plugins/](https://theme-next.org/docs/tag-plugins/)。 @@ -38,7 +38,7 @@ Hexo 主题一般都会扩展一些自己特有的标签插件，在这方面做 ### 插入表格数据 -如果想要在文章中显示一个表格，你可以使用 markdown 原生支持的语法，但是如果你想要让表格里的数据存储在外部文件中，那么你可以使用下面这种语法： +如果想要在文章中显示一个表格，你可以使用 Markdown 原生支持的语法，但是如果你想要让表格里的数据存储在外部文件中，那么你可以使用下面这种语法： ``` {% table [path] [thead1,thead2,...] %} @@ -77,7 +77,7 @@ Hexo 主题一般都会扩展一些自己特有的标签插件，在这方面做 ] ``` -2. 在文章或页面的 markdown 源文件中，插入如下标签。 +2. 在文章或页面的 Markdown 源文件中，插入如下标签。 ``` {% table _data/reward.json 时间,赞助人,金额,留言 %} @@ -99,7 +99,7 @@ any text {% endnote %} ``` -> 标签内可以是任意文字，支持 markdown 和 HTML 语法。 +> 标签内可以是任意文字，支持 Markdown 和 HTML 语法。 参数： @@ -189,7 +189,7 @@ This is success note. 数据的格式要和上面保持一致，即要有：`avatar`、`name`、`introduction`、`url` 几个字段。 ::: -2. 在文章或页面的 markdown 源文件中，插入如下标签。 +2. 在文章或页面的 Markdown 源文件中，插入如下标签。 ``` {% friends _data/friends.json %} diff --git a/docs/zh-CN/advanced/third-part.md b/docs/zh-CN/advanced/third-part.md index ba41a1a..e91fba1 100644 --- a/docs/zh-CN/advanced/third-part.md +++ b/docs/zh-CN/advanced/third-part.md @@ -154,7 +154,7 @@ quicklink: 2. 添加 `Front-Matter` -上一步只是设置了 home 页面和 archive 页面是否启用 quicklink，对于其他页面或文章，你必须手动设置：在页面或文章的 markdown 文件的 `Front-Matter` 中，添加 `quicklink: true`。 +上一步只是设置了 home 页面和 archive 页面是否启用 quicklink，对于其他页面或文章，你必须手动设置：在页面或文章的 Markdown 文件的 `Front-Matter` 中，添加 `quicklink: true`。 ## 启用 Pjax @@ -163,6 +163,8 @@ quicklink: ``` yaml pjax: enable: true + # 是否在页面加载后，滚动到第二屏 + scrollTo2screen: false # ！！！如果你不了解 Pjax 的用法，请忽视下面的配置项 # 详参见: https://github.com/MoOx/pjax/#options elements: @@ -181,8 +183,9 @@ pjax: ::: warning 已知问题 下面是启用 Pjax 之后，已知的一些问题。 -- 不兼容 MathJax（必须手动刷新页面一次后，MathJax 才能正常使用） +- 不兼容 MathJax（必须手动刷新页面一次后，MathJax 才能正常使用。KaTex 可以正常使用） - 不兼容评论（评论显示为空，必须手动刷新页面才能显示出用户的评论） +- 解析数学公式、Quicklink 等，原来按需生效的设置将会对所有页面生效 ::: ## 添加 Emoji 支持 @@ -213,7 +216,7 @@ $ hexo clean && hexo s {% github_emoji sparkles %} ``` -如果你需要某个 markdown 文件不解析这种语法，可以在 markdown 文件里的 `front-matter` 中，设置 `no-emoji: true`。这样 `::` 会保持原来的样子。 +如果你需要某个 Markdown 文件不解析这种语法，可以在 Markdown 文件里的 `front-matter` 中，设置 `no-emoji: true`。这样 `::` 会保持原来的样子。 ``` yaml --- @@ -224,7 +227,7 @@ no-emoji: true 有关该插件的更详尽的用法，请自行查阅其[文档](https://github.com/crimx/hexo-filter-github-emojis)。查看所有支持的 Emoji 请访问：[Github Emojis API](https://api.github.com/emojis) 或者 [Emoji Cheat Sheet](http://www.webpagefx.com/tools/emoji-cheat-sheet/)。 -> 你也可以通过更换 markdown 渲染器 `hexo-renderer-markdown-it-plus` 来支持 Emoji。详情请看：[https://github.com/CHENXCHEN/hexo-renderer-markdown-it-plus](https://github.com/CHENXCHEN/hexo-renderer-markdown-it-plus)。 +> 你也可以通过更换 Markdown 渲染器 `hexo-renderer-markdown-it-plus` 来支持 Emoji。详情请看：[https://github.com/CHENXCHEN/hexo-renderer-markdown-it-plus](https://github.com/CHENXCHEN/hexo-renderer-markdown-it-plus)。 ## 评论系统 @@ -627,7 +630,7 @@ MathJax 与 KaTex 相比之下，[KaTex 引擎速度更快](https://www.intmath. ### MathJax -使用 mathjax 作为引擎，首先，你需要更换一个支持 MathJax 的 markdown 渲染器： +使用 mathjax 作为引擎，首先，你需要更换一个支持 MathJax 的 Markdown 渲染器： - [hexo-renderer-kramed](https://github.com/sun11/hexo-renderer-kramed) - [hexo-renderer-pandoc](https://github.com/wzpan/hexo-renderer-pandoc) @@ -660,9 +663,9 @@ $ hexo clean && hexo s ### KaTex -使用 katex 作为引擎，不需要引入 `katex.min.js`。相应的，你只需要更换一个支持 KaTex 的 markdown 渲染器。 +使用 katex 作为引擎，不需要引入 `katex.min.js`。相应的，你只需要更换一个支持 KaTex 的 Markdown 渲染器。 -首先，卸载原来的 markdown 渲染器，例如： +首先，卸载原来的 Markdown 渲染器，例如： ``` bash $ npm un hexo-renderer-marked --save @@ -675,7 +678,7 @@ $ npm un hexo-renderer-pandoc --save $ npm un hexo-math --save ``` -如果你安装过这些，都需要卸载。你可以到 Hexo 根目录下的 `package.json` 文件中，查看安装了哪些插件。然后，安装新的 markdown 渲染器： +如果你安装过这些，都需要卸载。你可以到 Hexo 根目录下的 `package.json` 文件中，查看安装了哪些插件。然后，安装新的 Markdown 渲染器： - [hexo-renderer-markdown-it-plus](https://github.com/CHENXCHEN/hexo-renderer-markdown-it-plus) - [hexo-renderer-markdown-it](https://github.com/hexojs/hexo-renderer-markdown-it) @@ -754,7 +757,7 @@ Stun 主题默认提供了一些 MathJax 和 Katex 的插件。 ### 如何使用 -按照上述步骤配置之后，你就可以在 markdown 源文件中，使用数学公式了。使用 `$$...$$` 包裹的字符，即可被识别为数学公式，但是会另起一行来显示。如果想要公式和文字在同一行显示，需要使用 `$...$` 来包括字符。 +按照上述步骤配置之后，你就可以在 Markdown 源文件中，使用数学公式了。使用 `$$...$$` 包裹的字符，即可被识别为数学公式，但是会另起一行来显示。如果想要公式和文字在同一行显示，需要使用 `$...$` 来包括字符。 效果如下： diff --git a/docs/zh-CN/guide/primary-setting.md b/docs/zh-CN/guide/primary-setting.md index 2992f0e..58760a8 100644 --- a/docs/zh-CN/guide/primary-setting.md +++ b/docs/zh-CN/guide/primary-setting.md @@ -32,7 +32,7 @@ $ hexo new page tags 2. 修改 Front-Matter -找到 Hexo 根目录下的 `source/categories` 或 `source/tags` 文件夹中的 markdown 文件，添加 Front-Matter： +找到 Hexo 根目录下的 `source/categories` 或 `source/tags` 文件夹中的 Markdown 文件，添加 Front-Matter： ``` yaml # 如果是分类页，添加这个 @@ -150,7 +150,7 @@ header: ### 指定顶部图 -如果想要为某个页面或某篇文章单独指定顶部图，你需要在页面或文章 markdown 源文件的 [Front-Matter](https://hexo.io/zh-cn/docs/Front-Matter) 中，添加 `top_image` 项，然后填入的图片 url 或路径即可。例如： +如果想要为某个页面或某篇文章单独指定顶部图，你需要在页面或文章 Markdown 源文件的 [Front-Matter](https://hexo.io/zh-cn/docs/Front-Matter) 中，添加 `top_image` 项，然后填入的图片 url 或路径即可。例如： ``` yaml --- @@ -252,7 +252,7 @@ social: ## 文章摘要 -如果想要保留文章摘要，需要**手动**在文章的 markdown 源文件中添加 `` 标记。标记之前的部分都会被保留为文章摘要，显示在文章列表中。 +如果想要保留文章摘要，需要**手动**在文章的 Markdown 源文件中添加 `` 标记。标记之前的部分都会被保留为文章摘要，显示在文章列表中。 如果想要自动保留文章摘要，可以通过修改主题配置文件： @@ -285,6 +285,12 @@ reward: ![](https://raw.githubusercontent.com/liuyib/picBed/master/hexo-theme-stun/doc/20190608175556.png) +你可以在文章 Markdown 源文件中的 `Front-Matter` 里，设置 `reward: false` 来指定某篇文章不启用赞赏码。 + +::: warning 注意 +如果主题配置文件中没有启用 `reward`，那么单独设置文章 `reward: true` 是没有效果的。 +::: + --- 到这里就完成了最基本的配置，如果你还想更详细的配置主题，请查看【高级设置】部分。 diff --git a/layout/_partials/analytics/busuanzi.pug b/layout/_partials/analytics/busuanzi.pug index 328a95c..66efd97 100644 --- a/layout/_partials/analytics/busuanzi.pug +++ b/layout/_partials/analytics/busuanzi.pug @@ -2,7 +2,7 @@ div.busuanzi if theme.busuanzi.site_uv.enable - span.busuanzi-uv + span.busuanzi-site_uv i(class=`${fa_prefix} fa-user`) if !theme.busuanzi.icon_only span= __("footer.uv") + " " @@ -12,7 +12,7 @@ div.busuanzi span.separator= "|" if theme.busuanzi.site_pv.enable - span.busuanzi-pv + span.busuanzi-site_pv i(class=`${fa_prefix} fa-eye`) if !theme.busuanzi.icon_only span= __("footer.pv") + " " diff --git a/source/css/_common/components/analytics/busuanzi.styl b/source/css/_common/components/analytics/busuanzi.styl index 05f7766..6606762 100644 --- a/source/css/_common/components/analytics/busuanzi.styl +++ b/source/css/_common/components/analytics/busuanzi.styl @@ -1,17 +1,12 @@ .busuanzi { - &-uv { - color: $white-light; + &-site { + &_uv, + &_pv { + color: $white-light; - i { - margin: 0 .3rem 0 0; - } - } - - &-pv { - color: $white-light; - - i { - margin: 0 .3rem 0 0; + i { + margin: 0 .3rem 0 0; + } } } } -- GitLab