🐛 Fix: set mermaid theme as 'default' when initialization (#38)

This commit is contained in:
Cell
2022-01-25 16:39:46 +08:00
parent 05bd918cde
commit ce0d1ef130
8 changed files with 206 additions and 201 deletions
+1
View File
@@ -16,6 +16,7 @@ All notable changes to this project will be documented in this file.
- :zap: Perf: merge shortcode cardlink (deprecated v0.2.13) into shortcode link and add 'download' param ([#42](https://github.com/Lruihao/FixIt/issues/42))
- :zap: Perf: optimize JS loading ([#25](https://github.com/Lruihao/FixIt/issues/25))
- :recycle: Refactor: header title DOM and add subtitle option ([#26](https://github.com/Lruihao/FixIt/issues/26))
- :bug: Fix: set mermaid theme as 'default' when initialization ([#38](https://github.com/Lruihao/FixIt/issues/38))
- :bug: Fix: typeit print code error ([#19](https://github.com/Lruihao/FixIt/issues/19))
- :bug: Fix: pre element overflow error ([#29](https://github.com/Lruihao/FixIt/issues/29))
- :bug: Fix: toc display error without content header ([#21](https://github.com/Lruihao/FixIt/issues/21))
+1 -1
View File
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -2,7 +2,7 @@
weight: 3
title: "Theme Documentation - Built-in Shortcodes"
date: 2020-03-04T16:29:41+08:00
lastmod: 2020-03-04T16:29:41+08:00
lastmod: 2022-01-25T15:48:41+08:00
draft: false
author: "Lruihao"
authorLink: "https://lruihao.cn"
@@ -2,11 +2,11 @@
weight: 4
title: "Theme Documentation - Extended Shortcodes"
date: 2020-03-03T16:29:41+08:00
lastmod: 2020-03-03T16:29:41+08:00
lastmod: 2022-01-25T15:48:59+08:00
draft: false
author: "Dillon"
authorLink: "https://dillonzq.com"
description: "LoveIt theme provides multiple shortcodes on top of built-in ones in Hugo."
author: "Lruihao"
authorLink: "https://lruihao.cn"
description: "FixIt theme provides multiple shortcodes on top of built-in ones in Hugo."
resources:
- name: "featured-image"
src: "featured-image.jpg"
@@ -19,7 +19,7 @@ categories: ["documentation"]
lightgallery: true
---
**LoveIt** theme provides multiple shortcodes on top of built-in ones in Hugo.
**FixIt** theme provides multiple shortcodes on top of built-in ones in Hugo.
<!--more-->
@@ -472,10 +472,8 @@ end
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch
{{</* /mermaid */>}}
```
@@ -494,10 +492,8 @@ end
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch
{{< /mermaid >}}
@@ -1284,12 +1280,18 @@ Example `script` input:
```markdown
{{</* script */>}}
console.log('Hello LoveIt!');
console.log('Hello FixIt!');
{{</* /script */>}}
```
You can see the output in the console of the developer tool.
{{< script >}}
console.log('Hello LoveIt!');
console.log('Hello FixIt!');
{{< /script >}}
---
{{< admonition quote "Thanks" >}}
_Thanks to the original author [Dillon](https://dillonzq.com) for preparing and revising the content before version `v0.2.10` in this documentation._
{{< /admonition >}}
@@ -2,11 +2,11 @@
weight: 4
title: "主题文档 - 扩展 Shortcodes"
date: 2020-03-03T16:29:59+08:00
lastmod: 2020-03-03T16:29:59+08:00
lastmod: 2022-01-25T15:48:59+08:00
draft: false
author: "Dillon"
authorLink: "https://dillonzq.com"
description: "LoveIt 主题在 Hugo 内置的 shortcode 的基础上提供多个扩展的 shortcode."
author: "Lruihao"
authorLink: "https://lruihao.cn"
description: "FixIt 主题在 Hugo 内置的 shortcode 的基础上提供多个扩展的 shortcode."
resources:
- name: "featured-image"
src: "featured-image.jpg"
@@ -22,7 +22,7 @@ mapbox:
darkStyle: mapbox://styles/mapbox/dark-zh-v1?optimize=true
---
**LoveIt** 主题在 Hugo 内置的 shortcode 的基础上提供多个扩展的 shortcode.
**FixIt** 主题在 Hugo 内置的 shortcode 的基础上提供多个扩展的 shortcode.
<!--more-->
@@ -31,19 +31,19 @@ mapbox:
{{< version 0.2.0 changed >}}
{{< admonition >}}
Hugo **extended** 版本对于 `style` shortcode 是必需的.
Hugo **extended** 版本对于 `style` shortcode 是必需的
{{< /admonition >}}
`style` shortcode 用来在你的文章中插入自定义样式.
`style` shortcode 用来在你的文章中插入自定义样式
`style` shortcode 有两个位置参数.
`style` shortcode 有两个位置参数
第一个参数是自定义样式的内容. 它支持 [:(fab fa-sass fa-fw): SASS](https://sass-lang.com/documentation/style-rules/declarations#nesting) 中的嵌套语法,
并且 `&` 指代这个父元素.
第一个参数是自定义样式的内容它支持 [:(fab fa-sass fa-fw): SASS](https://sass-lang.com/documentation/style-rules/declarations#nesting) 中的嵌套语法
并且 `&` 指代这个父元素
第二个参数是包裹你要更改样式的内容的 HTML 标签, 默认值是 `div`.
第二个参数是包裹你要更改样式的内容的 HTML 标签默认值是 `div`
一个 `style` 示例:
一个 `style` 示例
```markdown
{{</* style "text-align:right; strong{color:#00b1ff;}" */>}}
@@ -51,7 +51,7 @@ This is a **right-aligned** paragraph.
{{</* /style */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< style "text-align:right; strong{color:#00b1ff;}" >}}
This is a **right-aligned** paragraph.
@@ -61,36 +61,36 @@ This is a **right-aligned** paragraph.
{{< version 0.2.0 >}}
`link` shortcode 是 [Markdown 链接语法](../basic-markdown-syntax#links) 的替代.
`link` shortcode 可以提供一些其它的功能并且可以在代码块中使用.
`link` shortcode 是 [Markdown 链接语法](../basic-markdown-syntax#links) 的替代
`link` shortcode 可以提供一些其它的功能并且可以在代码块中使用
{{< version 0.2.10 >}} 支持[本地资源引用](../theme-documentation-content#contents-organization)的完整用法.
{{< version 0.2.10 >}} 支持 [本地资源引用](../theme-documentation-content#contents-organization) 的完整用法
`link` shortcode 有以下命名参数:
`link` shortcode 有以下命名参数
* **href** *[必需]* (**第一个**位置参数)
* **href** *[必需]* (**第一个**位置参数
链接的目标.
链接的目标
* **content** *[可选]* (**第二个**位置参数)
* **content** *[可选]* (**第二个**位置参数
链接的内容, 默认值是 **href** 参数的值.
链接的内容默认值是 **href** 参数的值
*支持 Markdown 或者 HTML 格式.*
*支持 Markdown 或者 HTML 格式*
* **title** *[可选]* (**第三个**位置参数)
* **title** *[可选]* (**第三个**位置参数
HTML `a` 标签 的 `title` 属性, 当悬停在链接上会显示的提示.
HTML `a` 标签 的 `title` 属性当悬停在链接上会显示的提示
* **rel** *[可选]*
HTML `a` 标签 的 `rel` 补充属性.
HTML `a` 标签 的 `rel` 补充属性
* **class** *[可选]*
HTML `a` 标签 的 `class` 属性.
HTML `a` 标签 的 `class` 属性
一个 `link` 示例:
一个 `link` 示例
```markdown
{{</* link "https://assemble.io" */>}}
@@ -106,13 +106,13 @@ This is a **right-aligned** paragraph.
{{</* link href="https://assemble.io" content=Assemble */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
* {{< link "https://assemble.io" >}}
* {{< link "mailto:contact@revolunet.com" >}}
* {{< link "https://assemble.io" Assemble >}}
一个带有标题的 `link` 示例:
一个带有标题的 `link` 示例
```markdown
{{</* link "https://github.com/upstage/" Upstage "Visit Upstage!" */>}}
@@ -120,7 +120,7 @@ This is a **right-aligned** paragraph.
{{</* link href="https://github.com/upstage/" content=Upstage title="Visit Upstage!" */>}}
```
呈现的输出效果如下 (将鼠标悬停在链接上,会有一行提示):
呈现的输出效果如下 将鼠标悬停在链接上,会有一行提示:
{{< link "https://github.com/upstage/" Upstage "Visit Upstage!" >}}
@@ -128,75 +128,75 @@ This is a **right-aligned** paragraph.
{{< version 0.2.0 changed >}}
`image` shortcode 是 [`figure` shortcode](../theme-documentation-built-in-shortcodes#figure) 的替代. `image` shortcode 可以充分利用 [lazysizes](https://github.com/aFarkas/lazysizes) 和 [lightgallery.js](https://github.com/sachinchoolur/lightgallery.js) 两个依赖库.
`image` shortcode 是 [`figure` shortcode](../theme-documentation-built-in-shortcodes#figure) 的替代`image` shortcode 可以充分利用 [lazysizes](https://github.com/aFarkas/lazysizes) 和 [lightgallery.js](https://github.com/sachinchoolur/lightgallery.js) 两个依赖库
{{< version 0.2.10 >}} 支持[本地资源引用](../theme-documentation-content#contents-organization)的完整用法.
{{< version 0.2.10 >}} 支持 [本地资源引用](../theme-documentation-content#contents-organization) 的完整用法
`image` shortcode 有以下命名参数:
`image` shortcode 有以下命名参数
* **src** *[必需]* (**第一个**位置参数)
* **src** *[必需]* (**第一个**位置参数
图片的 URL.
* **alt** *[可选]* (**第二个**位置参数)
* **alt** *[可选]* (**第二个**位置参数
图片无法显示时的替代文本, 默认值是 **src** 参数的值.
图片无法显示时的替代文本默认值是 **src** 参数的值
*支持 Markdown 或者 HTML 格式.*
*支持 Markdown 或者 HTML 格式*
* **caption** *[可选]* (**第三个**位置参数)
* **caption** *[可选]* (**第三个**位置参数
图片标题.
图片标题
*支持 Markdown 或者 HTML 格式.*
*支持 Markdown 或者 HTML 格式*
* **title** *[可选]*
当悬停在图片上会显示的提示.
当悬停在图片上会显示的提示
* **class** *[可选]*
HTML `figure` 标签的 `class` 属性.
HTML `figure` 标签的 `class` 属性
* **src_s** *[可选]*
图片缩略图的 URL, 用在画廊模式中, 默认值是 **src** 参数的值.
图片缩略图的 URL, 用在画廊模式中默认值是 **src** 参数的值
* **src_l** *[可选]*
高清图片的 URL, 用在画廊模式中, 默认值是 **src** 参数的值.
高清图片的 URL, 用在画廊模式中默认值是 **src** 参数的值
* **height** *[可选]*
图片的 `height` 属性.
图片的 `height` 属性
* **width** *[可选]*
图片的 `width` 属性.
图片的 `width` 属性
* **linked** *[可选]*
图片是否需要被链接, 默认值是 `true`.
图片是否需要被链接默认值是 `true`
* **rel** *[可选]*
HTML `a` 标签 的 `rel` 补充属性, 仅在 **linked** 属性设置成 `true` 时有效.
HTML `a` 标签 的 `rel` 补充属性仅在 **linked** 属性设置成 `true` 时有效
一个 `image` 示例:
一个 `image` 示例
```markdown
{{</* image src="/images/lighthouse.jpg" caption="Lighthouse (`image`)" src_s="/images/lighthouse-small.jpg" src_l="/images/lighthouse-large.jpg" */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< image src="/images/lighthouse.jpg" caption="Lighthouse (`image`)" src_s="/images/lighthouse-small.jpg" src_l="/images/lighthouse-large.jpg" >}}
## 4 admonition
`admonition` shortcode 支持 **12** 种 帮助你在页面中插入提示的横幅.
`admonition` shortcode 支持 **12** 种 帮助你在页面中插入提示的横幅
*支持 Markdown 或者 HTML 格式.*
*支持 Markdown 或者 HTML 格式*
{{< admonition >}}
一个 **注意** 横幅
@@ -246,21 +246,21 @@ This is a **right-aligned** paragraph.
一个 **引用** 横幅
{{< /admonition >}}
`admonition` shortcode 有以下命名参数:
`admonition` shortcode 有以下命名参数
* **type** *[必需]* (**第一个**位置参数)
* **type** *[必需]* (**第一个**位置参数
`admonition` 横幅的类型, 默认值是 `note`.
`admonition` 横幅的类型默认值是 `note`
* **title** *[可选]* (**第二个**位置参数)
* **title** *[可选]* (**第二个**位置参数
`admonition` 横幅的标题, 默认值是 **type** 参数的值.
`admonition` 横幅的标题默认值是 **type** 参数的值
* **open** *[可选]* (**第三个**位置参数) {{< version 0.2.0 changed >}}
* **open** *[可选]* (**第三个**位置参数 {{< version 0.2.0 changed >}}
横幅内容是否默认展开, 默认值是 `true`.
横幅内容是否默认展开默认值是 `true`
一个 `admonition` 示例:
一个 `admonition` 示例
```markdown
{{</* admonition type=tip title="This is a tip" open=false */>}}
@@ -272,7 +272,7 @@ This is a **right-aligned** paragraph.
{{</* /admonition */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< admonition tip "This is a tip" false >}}
一个 **技巧** 横幅
@@ -280,13 +280,13 @@ This is a **right-aligned** paragraph.
## 5 mermaid
[mermaid](https://mermaidjs.github.io/) 是一个可以帮助你在文章中生成图表和流程图的库, 类似 Markdown 的语法.
[mermaid](https://mermaidjs.github.io/) 是一个可以帮助你在文章中生成图表和流程图的库类似 Markdown 的语法
只需将你的 mermaid 代码插入 `mermaid` shortcode 中即可.
只需将你的 mermaid 代码插入 `mermaid` shortcode 中即可
### 5.1 流程图 {#flowchart}
一个 **流程图** `mermaid` 示例:
一个 **流程图** `mermaid` 示例
```markdown
{{</* mermaid */>}}
@@ -298,7 +298,7 @@ graph LR;
{{</* /mermaid */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mermaid >}}
graph LR;
@@ -310,7 +310,7 @@ graph LR;
### 5.2 时序图 {#sequence-diagram}
一个 **时序图** `mermaid` 示例:
一个 **时序图** `mermaid` 示例
```markdown
{{</* mermaid */>}}
@@ -328,7 +328,7 @@ sequenceDiagram
{{</* /mermaid */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mermaid >}}
sequenceDiagram
@@ -346,7 +346,7 @@ sequenceDiagram
### 5.3 甘特图 {#gantt}
一个 **甘特图** `mermaid` 示例:
一个 **甘特图** `mermaid` 示例
```markdown
{{</* mermaid */>}}
@@ -368,7 +368,7 @@ gantt
{{</* /mermaid */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mermaid >}}
gantt
@@ -390,7 +390,7 @@ gantt
### 5.4 类图 {#class-diagram}
一个 **类图** `mermaid` 示例:
一个 **类图** `mermaid` 示例
```markdown
{{</* mermaid */>}}
@@ -411,7 +411,7 @@ classDiagram
{{</* /mermaid */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mermaid >}}
classDiagram
@@ -432,7 +432,7 @@ classDiagram
### 5.5 状态图 {#state-diagram}
一个 **状态图** `mermaid` 示例:
一个 **状态图** `mermaid` 示例
```markdown
{{</* mermaid */>}}
@@ -446,7 +446,7 @@ stateDiagram
{{</* /mermaid */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mermaid >}}
stateDiagram
@@ -460,7 +460,7 @@ stateDiagram
### 5.6 Git 图 {#git-graph}
一个 **Git 图** `mermaid` 示例:
一个 **Git 图** `mermaid` 示例
```markdown
{{</* mermaid */>}}
@@ -475,15 +475,13 @@ end
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch
{{</* /mermaid */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mermaid >}}
gitGraph:
@@ -497,16 +495,14 @@ end
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch
{{< /mermaid >}}
### 5.7 饼图 {#pie}
一个 **饼图** `mermaid` 示例:
一个 **饼图** `mermaid` 示例
```markdown
{{</* mermaid */>}}
@@ -517,7 +513,7 @@ pie
{{</* /mermaid */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mermaid >}}
pie
@@ -528,13 +524,13 @@ pie
## 6 echarts
[ECharts](https://echarts.apache.org/) 是一个帮助你生成交互式数据可视化的库.
[ECharts](https://echarts.apache.org/) 是一个帮助你生成交互式数据可视化的库
ECharts 提供了常规的 [折线图](https://echarts.apache.org/zh/option.html#series-line), [柱状图](https://echarts.apache.org/zh/option.html#series-line), [散点图](https://echarts.apache.org/zh/option.html#series-scatter), [饼图](https://echarts.apache.org/zh/option.html#series-pie), [K线图](https://echarts.apache.org/zh/option.html#series-candlestick), 用于统计的 [盒形图](https://echarts.apache.org/zh/option.html#series-boxplot), 用于地理数据可视化的 [地图](https://echarts.apache.org/zh/option.html#series-map), [热力图](https://echarts.apache.org/zh/option.html#series-heatmap), [线图](https://echarts.apache.org/zh/option.html#series-lines), 用于关系数据可视化的 [关系图](https://echarts.apache.org/zh/option.html#series-graph), [treemap](https://echarts.apache.org/zh/option.html#series-treemap), [旭日图](https://echarts.apache.org/zh/option.html#series-sunburst), 多维数据可视化的 [平行坐标](https://echarts.apache.org/zh/option.html#series-parallel), 还有用于 BI 的 [漏斗图](https://echarts.apache.org/zh/option.html#series-funnel), [仪表盘](https://echarts.apache.org/zh/option.html#series-gauge), 并且支持图与图之间的混搭.
ECharts 提供了常规的 [折线图](https://echarts.apache.org/zh/option.html#series-line), [柱状图](https://echarts.apache.org/zh/option.html#series-line), [散点图](https://echarts.apache.org/zh/option.html#series-scatter), [饼图](https://echarts.apache.org/zh/option.html#series-pie), [K 线图](https://echarts.apache.org/zh/option.html#series-candlestick), 用于统计的 [盒形图](https://echarts.apache.org/zh/option.html#series-boxplot), 用于地理数据可视化的 [地图](https://echarts.apache.org/zh/option.html#series-map), [热力图](https://echarts.apache.org/zh/option.html#series-heatmap), [线图](https://echarts.apache.org/zh/option.html#series-lines), 用于关系数据可视化的 [关系图](https://echarts.apache.org/zh/option.html#series-graph), [treemap](https://echarts.apache.org/zh/option.html#series-treemap), [旭日图](https://echarts.apache.org/zh/option.html#series-sunburst), 多维数据可视化的 [平行坐标](https://echarts.apache.org/zh/option.html#series-parallel), 还有用于 BI 的 [漏斗图](https://echarts.apache.org/zh/option.html#series-funnel), [仪表盘](https://echarts.apache.org/zh/option.html#series-gauge), 并且支持图与图之间的混搭
只需在 `echarts` shortcode 中以 `JSON`/`YAML`/`TOML`格式插入 ECharts 选项即可.
只需在 `echarts` shortcode 中以 `JSON`/`YAML`/`TOML`格式插入 ECharts 选项即可
一个 `JSON` 格式的 `echarts` 示例:
一个 `JSON` 格式的 `echarts` 示例
```json
{{</* echarts */>}}
@@ -609,7 +605,7 @@ ECharts 提供了常规的 [折线图](https://echarts.apache.org/zh/option.html
{{</* /echarts */>}}
```
一个 `YAML` 格式的 `echarts` 示例:
一个 `YAML` 格式的 `echarts` 示例
```yaml
{{</* echarts */>}}
@@ -709,7 +705,7 @@ series:
{{</* /echarts */>}}
```
一个 `TOML` 格式的 `echarts` 示例:
一个 `TOML` 格式的 `echarts` 示例
```toml
{{</* echarts */>}}
@@ -831,7 +827,7 @@ data = [
{{</* /echarts */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< echarts >}}
{
@@ -904,73 +900,73 @@ data = [
}
{{< /echarts >}}
`echarts` shortcode 还有以下命名参数:
`echarts` shortcode 还有以下命名参数
* **width** *[可选]* (**第一个**位置参数)
* **width** *[可选]* (**第一个**位置参数
{{< version 0.2.0 >}} 数据可视化的宽度, 默认值是 `100%`.
{{< version 0.2.0 >}} 数据可视化的宽度默认值是 `100%`
* **height** *[可选]* (**第二个**位置参数)
* **height** *[可选]* (**第二个**位置参数
{{< version 0.2.0 >}} 数据可视化的高度, 默认值是 `30rem`.
{{< version 0.2.0 >}} 数据可视化的高度默认值是 `30rem`
## 7 mapbox
{{< version 0.2.0 >}}
[Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js) 是一个 JavaScript 库,它使用 WebGL, 以 [vector tiles](https://docs.mapbox.com/help/glossary/vector-tiles/) 和 [Mapbox styles](https://docs.mapbox.com/mapbox-gl-js/style-spec/) 为来源, 将它们渲染成互动式地图.
[Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js) 是一个 JavaScript 库,它使用 WebGL, 以 [vector tiles](https://docs.mapbox.com/help/glossary/vector-tiles/) 和 [Mapbox styles](https://docs.mapbox.com/mapbox-gl-js/style-spec/) 为来源将它们渲染成互动式地图
`mapbox` shortcode 有以下命名参数来使用 Mapbox GL JS:
* **lng** *[必需]* (**第一个**位置参数)
* **lng** *[必需]* (**第一个**位置参数
地图初始中心点的经度, 以度为单位.
地图初始中心点的经度以度为单位
* **lat** *[必需]* (**第二个**位置参数)
* **lat** *[必需]* (**第二个**位置参数
地图初始中心点的纬度, 以度为单位.
地图初始中心点的纬度以度为单位
* **zoom** *[可选]* (**第三个**位置参数)
* **zoom** *[可选]* (**第三个**位置参数
地图的初始缩放级别, 默认值是 `10`.
地图的初始缩放级别默认值是 `10`
* **marked** *[可选]* (**第四个**位置参数)
* **marked** *[可选]* (**第四个**位置参数
是否在地图的初始中心点添加图钉, 默认值是 `true`.
是否在地图的初始中心点添加图钉默认值是 `true`
* **light-style** *[可选]* (**第五个**位置参数)
* **light-style** *[可选]* (**第五个**位置参数
浅色主题的地图样式, 默认值是[前置参数](../theme-documentation-content#front-matter)或者[网站配置](../theme-documentation-basics#site-configuration)中设置的值.
浅色主题的地图样式默认值是 [前置参数](../theme-documentation-content#front-matter) 或者 [网站配置](../theme-documentation-basics#site-configuration) 中设置的值
* **dark-style** *[可选]* (**第六个**位置参数)
* **dark-style** *[可选]* (**第六个**位置参数
深色主题的地图样式, 默认值是[前置参数](../theme-documentation-content#front-matter)或者[网站配置](../theme-documentation-basics#site-configuration)中设置的值.
深色主题的地图样式默认值是 [前置参数](../theme-documentation-content#front-matter) 或者 [网站配置](../theme-documentation-basics#site-configuration) 中设置的值
* **navigation** *[可选]*
是否添加 [NavigationControl](https://docs.mapbox.com/mapbox-gl-js/api#navigationcontrol), 默认值是[前置参数](../theme-documentation-content#front-matter)或者[网站配置](../theme-documentation-basics#site-configuration)中设置的值.
是否添加 [NavigationControl](https://docs.mapbox.com/mapbox-gl-js/api#navigationcontrol), 默认值是 [前置参数](../theme-documentation-content#front-matter) 或者 [网站配置](../theme-documentation-basics#site-configuration) 中设置的值
* **geolocate** *[可选]*
是否添加 [GeolocateControl](https://docs.mapbox.com/mapbox-gl-js/api#geolocatecontrol), 默认值是[前置参数](../theme-documentation-content#front-matter)或者[网站配置](../theme-documentation-basics#site-configuration)中设置的值.
是否添加 [GeolocateControl](https://docs.mapbox.com/mapbox-gl-js/api#geolocatecontrol), 默认值是 [前置参数](../theme-documentation-content#front-matter) 或者 [网站配置](../theme-documentation-basics#site-configuration) 中设置的值
* **scale** *[可选]*
是否添加 [ScaleControl](https://docs.mapbox.com/mapbox-gl-js/api#scalecontrol), 默认值是[前置参数](../theme-documentation-content#front-matter)或者[网站配置](../theme-documentation-basics#site-configuration)中设置的值.
是否添加 [ScaleControl](https://docs.mapbox.com/mapbox-gl-js/api#scalecontrol), 默认值是 [前置参数](../theme-documentation-content#front-matter) 或者 [网站配置](../theme-documentation-basics#site-configuration) 中设置的值
* **fullscreen** *[可选]*
是否添加 [FullscreenControl](https://docs.mapbox.com/mapbox-gl-js/api#fullscreencontrol), 默认值是[前置参数](../theme-documentation-content#front-matter)或者[网站配置](../theme-documentation-basics#site-configuration)中设置的值.
是否添加 [FullscreenControl](https://docs.mapbox.com/mapbox-gl-js/api#fullscreencontrol), 默认值是 [前置参数](../theme-documentation-content#front-matter) 或者 [网站配置](../theme-documentation-basics#site-configuration) 中设置的值
* **width** *[可选]*
地图的宽度, 默认值是 `100%`.
地图的宽度默认值是 `100%`
* **height** *[可选]*
地图的高度, 默认值是 `20rem`.
地图的高度默认值是 `20rem`
一个简单的 `mapbox` 示例:
一个简单的 `mapbox` 示例
```markdown
{{</* mapbox 121.485 31.233 12 */>}}
@@ -978,11 +974,11 @@ data = [
{{</* mapbox lng=121.485 lat=31.233 zoom=12 */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mapbox 121.485 31.233 12 >}}
一个带有自定义样式的 `mapbox` 示例:
一个带有自定义样式的 `mapbox` 示例
```markdown
{{</* mapbox -122.252 37.453 10 false "mapbox://styles/mapbox/streets-zh-v1" */>}}
@@ -990,57 +986,57 @@ data = [
{{</* mapbox lng=-122.252 lat=37.453 zoom=10 marked=false light-style="mapbox://styles/mapbox/streets-zh-v1" */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< mapbox -122.252 37.453 10 false "mapbox://styles/mapbox/streets-zh-v1?optimize=true" >}}
## 8 music
`music` shortcode 基于 [APlayer](https://github.com/MoePlayer/APlayer) 和 [MetingJS](https://github.com/metowolf/MetingJS) 提供了一个内嵌的响应式音乐播放器.
`music` shortcode 基于 [APlayer](https://github.com/MoePlayer/APlayer) 和 [MetingJS](https://github.com/metowolf/MetingJS) 提供了一个内嵌的响应式音乐播放器
有三种方式使用 `music` shortcode.
### 8.1 自定义音乐 URL {#custom-music-url}
{{< version 0.2.10 >}} 支持[本地资源引用](../theme-documentation-content#contents-organization)的完整用法.
{{< version 0.2.10 >}} 支持 [本地资源引用](../theme-documentation-content#contents-organization) 的完整用法
`music` shortcode 有以下命名参数来使用自定义音乐 URL:
* **server** *[必需]*
音乐的链接.
音乐的链接
* **type** *[可选]*
音乐的名称.
音乐的名称
* **artist** *[可选]*
音乐的创作者.
音乐的创作者
* **cover** *[可选]*
音乐的封面链接.
音乐的封面链接
一个使用自定义音乐 URL 的 `music` 示例:
一个使用自定义音乐 URL 的 `music` 示例
```markdown
{{</* music url="/music/Wavelength.mp3" name=Wavelength artist=oldmanyoung cover="/images/Wavelength.jpg" */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< music url="/music/Wavelength.mp3" name=Wavelength artist=oldmanyoung cover="/images/Wavelength.jpg" >}}
### 8.2 音乐平台 URL 的自动识别 {#automatic-identification}
`music` shortcode 有一个命名参数来使用音乐平台 URL 的自动识别:
`music` shortcode 有一个命名参数来使用音乐平台 URL 的自动识别
* **auto** *[必需]]* (**第一个**位置参数)
* **auto** *[必需]]* (**第一个**位置参数
用来自动识别的音乐平台 URL, 支持 `netease`, `tencent``xiami` 平台.
用来自动识别的音乐平台 URL, 支持 `netease`, `tencent``xiami` 平台
一个使用音乐平台 URL 的自动识别的 `music` 示例:
一个使用音乐平台 URL 的自动识别的 `music` 示例
```markdown
{{</* music auto="https://music.163.com/#/playlist?id=60198" */>}}
@@ -1048,31 +1044,31 @@ data = [
{{</* music "https://music.163.com/#/playlist?id=60198" */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< music auto="https://music.163.com/#/playlist?id=60198" >}}
### 8.3 自定义音乐平台, 类型和 ID {#custom-server}
### 8.3 自定义音乐平台类型和 ID {#custom-server}
`music` shortcode 有以下命名参数来使用自定义音乐平台:
`music` shortcode 有以下命名参数来使用自定义音乐平台
* **server** *[必需]* (**第一个**位置参数)
* **server** *[必需]* (**第一个**位置参数
[`netease`, `tencent`, `kugou`, `xiami`, `baidu`]
音乐平台.
音乐平台
* **type** *[必需]* (**第二个**位置参数)
* **type** *[必需]* (**第二个**位置参数
[`song`, `playlist`, `album`, `search`, `artist`]
音乐类型.
音乐类型
* **id** *[必需]* (**第三个**位置参数)
* **id** *[必需]* (**第三个**位置参数
歌曲 ID, 或者播放列表 ID, 或者专辑 ID, 或者搜索关键词, 或者创作者 ID.
歌曲 ID, 或者播放列表 ID, 或者专辑 ID, 或者搜索关键词或者创作者 ID.
一个使用自定义音乐平台的 `music` 示例:
一个使用自定义音乐平台的 `music` 示例
```markdown
{{</* music server="netease" type="song" id="1868553" */>}}
@@ -1080,73 +1076,73 @@ data = [
{{</* music netease song 1868553 */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< music netease song 1868553 >}}
### 8.4 其它参数 {#other-parameters}
`music` shortcode 有一些可以应用于以上三种方式的其它命名参数:
`music` shortcode 有一些可以应用于以上三种方式的其它命名参数
* **theme** *[可选]*
{{< version 0.2.0 changed >}} 音乐播放器的主题色, 默认值是 `#448aff`.
{{< version 0.2.0 changed >}} 音乐播放器的主题色默认值是 `#448aff`
* **fixed** *[可选]*
是否开启固定模式, 默认值是 `false`.
是否开启固定模式默认值是 `false`
* **mini** *[可选]*
是否开启迷你模式, 默认值是 `false`.
是否开启迷你模式默认值是 `false`
* **autoplay** *[可选]*
是否自动播放音乐, 默认值是 `false`.
是否自动播放音乐默认值是 `false`
* **volume** *[可选]*
第一次打开播放器时的默认音量, 会被保存在浏览器缓存中, 默认值是 `0.7`.
第一次打开播放器时的默认音量会被保存在浏览器缓存中默认值是 `0.7`
* **mutex** *[可选]*
是否自动暂停其它播放器, 默认值是 `true`.
是否自动暂停其它播放器默认值是 `true`
`music` shortcode 还有一些只适用于音乐列表方式的其它命名参数:
`music` shortcode 还有一些只适用于音乐列表方式的其它命名参数
* **loop** *[可选]*
[`all`, `one`, `none`]
音乐列表的循环模式, 默认值是 `none`.
音乐列表的循环模式默认值是 `none`
* **order** *[可选]*
[`list`, `random`]
音乐列表的播放顺序, 默认值是 `list`.
音乐列表的播放顺序默认值是 `list`
* **list-folded** *[可选]*
初次打开的时候音乐列表是否折叠, 默认值是 `false`.
初次打开的时候音乐列表是否折叠默认值是 `false`
* **list-max-height** *[可选]*
音乐列表的最大高度, 默认值是 `340px`.
音乐列表的最大高度默认值是 `340px`
## 9 bilibili
{{< version 0.2.0 changed >}}
`bilibili` shortcode 提供了一个内嵌的用来播放 bilibili 视频的响应式播放器.
`bilibili` shortcode 提供了一个内嵌的用来播放 bilibili 视频的响应式播放器
如果视频只有一个部分, 则仅需要视频的 BV `id`, 例如:
如果视频只有一个部分则仅需要视频的 BV `id`, 例如
```code
https://www.bilibili.com/video/BV1Sx411T7QQ
```
一个 `bilibili` 示例:
一个 `bilibili` 示例
```markdown
{{</* bilibili BV1Sx411T7QQ */>}}
@@ -1154,17 +1150,17 @@ https://www.bilibili.com/video/BV1Sx411T7QQ
{{</* bilibili id=BV1Sx411T7QQ */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< bilibili id=BV1Sx411T7QQ >}}
如果视频包含多个部分, 则除了视频的 BV `id` 之外, 还需要 `p`, 默认值为 `1`, 例如:
如果视频包含多个部分则除了视频的 BV `id` 之外还需要 `p`, 默认值为 `1`, 例如
```code
https://www.bilibili.com/video/BV1TJ411C7An?p=3
```
一个带有 `p` 参数的 `bilibili` 示例:
一个带有 `p` 参数的 `bilibili` 示例
```markdown
{{</* bilibili BV1TJ411C7An 3 */>}}
@@ -1172,55 +1168,55 @@ https://www.bilibili.com/video/BV1TJ411C7An?p=3
{{</* bilibili id=BV1TJ411C7An p=3 */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< bilibili id=BV1TJ411C7An p=3 >}}
## 10 typeit
`typeit` shortcode 基于 [TypeIt](https://typeitjs.com/) 提供了打字动画.
`typeit` shortcode 基于 [TypeIt](https://typeitjs.com/) 提供了打字动画
只需将你需要打字动画的内容插入 `typeit` shortcode 中即可.
只需将你需要打字动画的内容插入 `typeit` shortcode 中即可
### 10.1 简单内容 {#simple-content}
允许使用 `Markdown` 格式的简单内容, 并且 **不包含** 富文本的块内容, 例如图像等等...
允许使用 `Markdown` 格式的简单内容并且 **不包含** 富文本的块内容例如图像等等 ...
一个 `typeit` 示例:
一个 `typeit` 示例
```markdown
{{</* typeit */>}}
这一个带有基于 [TypeIt](https://typeitjs.com/) 的 **打字动画***段落*...
这一个带有基于 [TypeIt](https://typeitjs.com/) 的 **打字动画***段落* ...
{{</* /typeit */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< typeit >}}
这一个带有基于 [TypeIt](https://typeitjs.com/) 的 **打字动画***段落*...
这一个带有基于 [TypeIt](https://typeitjs.com/) 的 **打字动画***段落* ...
{{< /typeit >}}
另外, 你也可以自定义 **HTML 标签**.
另外你也可以自定义 **HTML 标签**.
一个带有 `h4` 标签的 `typeit` 示例:
一个带有 `h4` 标签的 `typeit` 示例
```markdown
{{</* typeit tag=h4 */>}}
这一个带有基于 [TypeIt](https://typeitjs.com/) 的 **打字动画***段落*...
这一个带有基于 [TypeIt](https://typeitjs.com/) 的 **打字动画***段落* ...
{{</* /typeit */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< typeit tag=h4 >}}
这一个带有基于 [TypeIt](https://typeitjs.com/) 的 **打字动画***段落*...
这一个带有基于 [TypeIt](https://typeitjs.com/) 的 **打字动画***段落* ...
{{< /typeit >}}
### 10.2 代码内容 {#code-content}
代码内容也是允许的, 并且通过使用参数 `code` 指定语言类型可以实习语法高亮.
代码内容也是允许的并且通过使用参数 `code` 指定语言类型可以实习语法高亮
一个带有 `code` 参数的 `typeit` 示例:
一个带有 `code` 参数的 `typeit` 示例
```markdown
{{</* typeit code=java */>}}
@@ -1232,7 +1228,7 @@ public class HelloWorld {
{{</* /typeit */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< typeit code=java >}}
public class HelloWorld {
@@ -1244,12 +1240,12 @@ public class HelloWorld {
### 10.3 分组内容 {#code-content}
默认情况下, 所有打字动画都是同时开始的.
但是有时你可能需要按顺序开始一组 `typeit` 内容的打字动画.
默认情况下所有打字动画都是同时开始的
但是有时你可能需要按顺序开始一组 `typeit` 内容的打字动画
一组具有相同 `group` 参数值的 `typeit` 内容将按顺序开始打字动画.
一组具有相同 `group` 参数值的 `typeit` 内容将按顺序开始打字动画
一个带有 `group` 参数的 `typeit` 示例:
一个带有 `group` 参数的 `typeit` 示例
```markdown
{{</* typeit group=paragraph */>}}
@@ -1261,7 +1257,7 @@ public class HelloWorld {
{{</* /typeit */>}}
```
呈现的输出效果如下:
呈现的输出效果如下
{{< typeit group=paragraph >}}
**首先**, 这个段落开始
@@ -1275,23 +1271,29 @@ public class HelloWorld {
{{< version 0.2.8 >}}
`script` shortcode 用来在你的文章中插入 **:(fab fa-js fa-fw): Javascript** 脚本.
`script` shortcode 用来在你的文章中插入 **:(fab fa-js fa-fw): Javascript** 脚本
{{< admonition >}}
脚本内容可以保证在所有的第三方库加载之后按顺序执行.
所以你可以自由地使用第三方库.
脚本内容可以保证在所有的第三方库加载之后按顺序执行
所以你可以自由地使用第三方库
{{< /admonition >}}
一个 `script` 示例:
一个 `script` 示例
```markdown
{{</* script */>}}
console.log('Hello LoveIt!');
console.log('Hello FixIt!');
{{</* /script */>}}
```
你可以在开发者工具的控制台中看到输出.
你可以在开发者工具的控制台中看到输出
{{< script >}}
console.log('Hello LoveIt!');
console.log('Hello FixIt!');
{{< /script >}}
---
{{< admonition quote "感谢" >}}
_本文档中 `v0.2.10` 版本之前的内容,感谢原作者 [Dillon](https://dillonzq.com) 编写修订。_
{{< /admonition >}}
+1 -1
View File
@@ -475,7 +475,7 @@ class Theme {
initMermaid() {
const $mermaidElements = document.getElementsByClassName('mermaid');
if ($mermaidElements.length) {
mermaid.initialize({startOnLoad: false, theme: 'null'});
mermaid.initialize({startOnLoad: false, theme: 'default'});
this.util.forEach($mermaidElements, $mermaid => {
mermaid.mermaidAPI.render('svg-' + $mermaid.id, this.data[$mermaid.id], svgCode => {
$mermaid.insertAdjacentHTML('afterbegin', svgCode);
File diff suppressed because one or more lines are too long