Skip to content
This repository was archived by the owner on Mar 9, 2022. It is now read-only.

Commit

Permalink
docs: removed old documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
victor-pogor committed Dec 26, 2020
1 parent d0fe529 commit 1c82984
Show file tree
Hide file tree
Showing 9 changed files with 228 additions and 309 deletions.
121 changes: 55 additions & 66 deletions exampleSite/content/posts/theme-documentation-basics/index.en.md

Large diffs are not rendered by default.

121 changes: 55 additions & 66 deletions exampleSite/content/posts/theme-documentation-basics/index.fr.md

Large diffs are not rendered by default.

121 changes: 55 additions & 66 deletions exampleSite/content/posts/theme-documentation-basics/index.zh-cn.md

Large diffs are not rendered by default.

32 changes: 14 additions & 18 deletions exampleSite/content/posts/theme-documentation-content/index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ A few suggestions to help you get a good looking site quickly:
- Local resources organization

{{< admonition note "Local Resource Reference" >}}
{{< version 0.2.10 >}}

There are three ways to reference local resources such as **images** and **music**:

Expand Down Expand Up @@ -132,7 +131,7 @@ seo:
```

- **title**: the title for the content.
- **subtitle**: {{< version 0.2.0 >}} the subtitle for the content.
- **subtitle**: the subtitle for the content.
- **date**: the datetime assigned to this page, which is usually fetched from the `date` field in front matter, but this behaviour is configurabl in the [site configuration](../theme-documentation-basics#site-configuration).
- **lastmod**: the datetime at which the content was last modified.
- **draft**: if `true`, the content will not be rendered unless the `--buildDrafts`/`-D` flag is passed to the `hugo` command.
Expand All @@ -148,26 +147,25 @@ seo:
- **featuredImagePreview**: the featured image for the content preview in the home page.

- **hiddenFromHomePage**: if `true`, the content will not be shown in the home page.
- **hiddenFromSearch**: {{< version 0.2.0 >}} if `true`, the content will not be shown in the search results.
- **twemoji**: {{< version 0.2.0 >}} if `true`, the content will enable the twemoji.
- **hiddenFromSearch**: if `true`, the content will not be shown in the search results.
- **twemoji**: if `true`, the content will enable the twemoji.
- **lightgallery**: if `true`, images in the content will be shown as the gallery.
- **ruby**: {{< version 0.2.0 >}} if `true`, the content will enable the [ruby extended syntax](#ruby).
- **fraction**: {{< version 0.2.0 >}} if `true`, the content will enable the [fraction extended syntax](#fraction).
- **fontawesome**: {{< version 0.2.0 >}} if `true`, the content will enable the [Font Awesome extended syntax](#fontawesome).
- **ruby**: if `true`, the content will enable the [ruby extended syntax](#ruby).
- **fraction**: if `true`, the content will enable the [fraction extended syntax](#fraction).
- **fontawesome**: if `true`, the content will enable the [Font Awesome extended syntax](#fontawesome).
- **linkToMarkdown**: if `true`, the footer of the content will be shown the link to the orignal Markdown file.
- **rssFullText**: {{< version 0.2.4 >}} if `true`, the full text content will be shown in RSS.
- **rssFullText**: if `true`, the full text content will be shown in RSS.

- **toc**: {{< version 0.2.9 changed >}} the same as the `params.page.toc` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **code**: {{< version 0.2.0 >}} the same as the `params.page.code` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **math**: {{< version 0.2.0 changed >}} the same as the `params.page.math` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **mapbox**: {{< version 0.2.0 >}} the same as the `params.page.mapbox` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **toc**: the same as the `params.page.toc` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **code**: the same as the `params.page.code` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **math**: the same as the `params.page.math` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **mapbox**: the same as the `params.page.mapbox` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **share**: the same as the `params.page.share` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **comment**: {{< version 0.2.0 changed >}} the same as the `params.page.comment` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **library**: {{< version 0.2.7 >}} the same as the `params.page.library` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **seo**: {{< version 0.2.10 >}} the same as the `params.page.seo` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **comment**: the same as the `params.page.comment` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **library**: the same as the `params.page.library` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **seo**: the same as the `params.page.seo` part in the [site configuration](../theme-documentation-basics#site-configuration).

{{< admonition tip >}}
{{< version 0.2.10 >}}

**featuredImage** and **featuredImagePreview** support the complete usage of [local resource references](#contents-organization).

Expand Down Expand Up @@ -330,8 +328,6 @@ The rendered output looks like this:

### Fraction {#fraction}

{{< version 0.2.0 >}}

An extended Markdown syntax for **fraction** is supported in **CodeIT** theme:

```markdown
Expand Down
32 changes: 14 additions & 18 deletions exampleSite/content/posts/theme-documentation-content/index.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ A few suggestions to help you get a good looking site quickly:
- Local resources organization

{{< admonition note "Local Resource Reference" >}}
{{< version 0.2.10 >}}

There are three ways to reference local resources such as **images** and **music**:

Expand Down Expand Up @@ -137,7 +136,7 @@ seo:
```

- **title**: the title for the content.
- **subtitle**: {{< version 0.2.0 >}} the subtitle for the content.
- **subtitle**: the subtitle for the content.
- **date**: the datetime assigned to this page, which is usually fetched from the `date` field in front matter, but this behaviour is configurabl in the [site configuration](../theme-documentation-basics#site-configuration).
- **lastmod**: the datetime at which the content was last modified.
- **draft**: if `true`, the content will not be rendered unless the `--buildDrafts`/`-D` flag is passed to the `hugo` command.
Expand All @@ -153,26 +152,25 @@ seo:
- **featuredImagePreview**: the featured image for the content preview in the home page.

- **hiddenFromHomePage**: if `true`, the content will not be shown in the home page.
- **hiddenFromSearch**: {{< version 0.2.0 >}} if `true`, the content will not be shown in the search results.
- **twemoji**: {{< version 0.2.0 >}} if `true`, the content will enable the twemoji.
- **hiddenFromSearch**: if `true`, the content will not be shown in the search results.
- **twemoji**: if `true`, the content will enable the twemoji.
- **lightgallery**: if `true`, images in the content will be shown as the gallery.
- **ruby**: {{< version 0.2.0 >}} if `true`, the content will enable the [ruby extended syntax](#ruby).
- **fraction**: {{< version 0.2.0 >}} if `true`, the content will enable the [fraction extended syntax](#fraction).
- **fontawesome**: {{< version 0.2.0 >}} if `true`, the content will enable the [Font Awesome extended syntax](#fontawesome).
- **ruby**: if `true`, the content will enable the [ruby extended syntax](#ruby).
- **fraction**: if `true`, the content will enable the [fraction extended syntax](#fraction).
- **fontawesome**: if `true`, the content will enable the [Font Awesome extended syntax](#fontawesome).
- **linkToMarkdown**: if `true`, the footer of the content will be shown the link to the orignal Markdown file.
- **rssFullText**: {{< version 0.2.4 >}} if `true`, the full text content will be shown in RSS.
- **rssFullText**: if `true`, the full text content will be shown in RSS.

- **toc**: {{< version 0.2.9 changed >}} the same as the `params.page.toc` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **code**: {{< version 0.2.0 >}} the same as the `params.page.code` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **math**: {{< version 0.2.0 changed >}} the same as the `params.page.math` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **mapbox**: {{< version 0.2.0 >}} the same as the `params.page.mapbox` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **toc**: the same as the `params.page.toc` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **code**: the same as the `params.page.code` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **math**: the same as the `params.page.math` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **mapbox**: the same as the `params.page.mapbox` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **share**: the same as the `params.page.share` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **comment**: {{< version 0.2.0 changed >}} the same as the `params.page.comment` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **library**: {{< version 0.2.7 >}} the same as the `params.page.library` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **seo**: {{< version 0.2.10 >}} the same as the `params.page.seo` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **comment**: the same as the `params.page.comment` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **library**: the same as the `params.page.library` part in the [site configuration](../theme-documentation-basics#site-configuration).
- **seo**: the same as the `params.page.seo` part in the [site configuration](../theme-documentation-basics#site-configuration).

{{< admonition tip >}}
{{< version 0.2.10 >}}

**featuredImage** and **featuredImagePreview** support the complete usage of [local resource references](#contents-organization).

Expand Down Expand Up @@ -335,8 +333,6 @@ The rendered output looks like this:

### Fraction {#fraction}

{{< version 0.2.0 >}}

An extended Markdown syntax for **fraction** is supported in **CodeIT** theme:

```markdown
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ math:
- 本地资源组织

{{< admonition note "本地资源引用" >}}
{{< version 0.2.10 >}}

有三种方法来引用**图片****音乐**等本地资源:

Expand Down Expand Up @@ -131,7 +130,7 @@ seo:
```

- **title**: 文章标题.
- **subtitle**: {{< version 0.2.0 >}} 文章副标题.
- **subtitle**: 文章副标题.
- **date**: 这篇文章创建的日期时间. 它通常是从文章的前置参数中的 `date` 字段获取的, 但是也可以在 [网站配置](../theme-documentation-basics#site-configuration) 中设置.
- **lastmod**: 上次修改内容的日期时间.
- **draft**: 如果设为 `true`, 除非 `hugo` 命令使用了 `--buildDrafts`/`-D` 参数, 这篇文章不会被渲染.
Expand All @@ -147,26 +146,25 @@ seo:
- **featuredImagePreview**: 用在主页预览的文章特色图片.

- **hiddenFromHomePage**: 如果设为 `true`, 这篇文章将不会显示在主页上.
- **hiddenFromSearch**: {{< version 0.2.0 >}} 如果设为 `true`, 这篇文章将不会显示在搜索结果中.
- **twemoji**: {{< version 0.2.0 >}} 如果设为 `true`, 这篇文章会使用 twemoji.
- **hiddenFromSearch**: 如果设为 `true`, 这篇文章将不会显示在搜索结果中.
- **twemoji**: 如果设为 `true`, 这篇文章会使用 twemoji.
- **lightgallery**: 如果设为 `true`, 文章中的图片将可以按照画廊形式呈现.
- **ruby**: {{< version 0.2.0 >}} 如果设为 `true`, 这篇文章会使用 [上标注释扩展语法](#ruby).
- **fraction**: {{< version 0.2.0 >}} 如果设为 `true`, 这篇文章会使用 [分数扩展语法](#fraction).
- **fontawesome**: {{< version 0.2.0 >}} 如果设为 `true`, 这篇文章会使用 [Font Awesome 扩展语法](#fontawesome).
- **ruby**: 如果设为 `true`, 这篇文章会使用 [上标注释扩展语法](#ruby).
- **fraction**: 如果设为 `true`, 这篇文章会使用 [分数扩展语法](#fraction).
- **fontawesome**: 如果设为 `true`, 这篇文章会使用 [Font Awesome 扩展语法](#fontawesome).
- **linkToMarkdown**: 如果设为 `true`, 内容的页脚将显示指向原始 Markdown 文件的链接.
- **rssFullText**: {{< version 0.2.4 >}} 如果设为 `true`, 在 RSS 中将会显示全文内容.
- **rssFullText**: 如果设为 `true`, 在 RSS 中将会显示全文内容.

- **toc**: {{< version 0.2.9 changed >}} [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.toc` 部分相同.
- **code**: {{< version 0.2.0 >}} [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.code` 部分相同.
- **math**: {{< version 0.2.0 changed >}} [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.math` 部分相同.
- **mapbox**: {{< version 0.2.0 >}} [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.mapbox` 部分相同.
- **toc**: 和 [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.toc` 部分相同.
- **code**: 和 [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.code` 部分相同.
- **math**: 和 [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.math` 部分相同.
- **mapbox**: 和 [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.mapbox` 部分相同.
- **share**: 和 [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.share` 部分相同.
- **comment**: {{< version 0.2.0 changed >}} [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.comment` 部分相同.
- **library**: {{< version 0.2.7 >}} [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.library` 部分相同.
- **seo**: {{< version 0.2.10 >}} [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.seo` 部分相同.
- **comment**: 和 [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.comment` 部分相同.
- **library**: 和 [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.library` 部分相同.
- **seo**: 和 [网站配置](../theme-documentation-basics#site-configuration) 中的 `params.page.seo` 部分相同.

{{< admonition tip >}}
{{< version 0.2.10 >}}

**featuredImage****featuredImagePreview** 支持[本地资源引用](#contents-organization)的完整用法.

Expand Down Expand Up @@ -329,8 +327,6 @@ $$ \ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-} $$

### 分数 {#fraction}

{{< version 0.2.0 >}}

**CodeIT** 主题支持一种 **分数** Markdown 扩展语法:

```markdown
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ lightgallery: true

## 1 style

{{< version 0.2.0 changed >}}

{{< admonition >}}
Hugo **extended** version is necessary for `style` shortcode.
{{< /admonition >}}
Expand Down Expand Up @@ -57,11 +55,9 @@ This is a **right-aligned** paragraph.

## 2 link

{{< version 0.2.0 >}}

`link` shortcode is an alternative to [Markdown link syntax](../basic-markdown-syntax#links). `link` shortcode can provide some other features and can be used in code blocks.

{{< version 0.2.10 >}} The complete usage of [local resource references](../theme-documentation-content#contents-organization) is supported.
The complete usage of [local resource references](../theme-documentation-content#contents-organization) is supported.

The `link` shortcode has the following named parameters:

Expand Down Expand Up @@ -123,11 +119,9 @@ The rendered output looks like this (hover over the link, there should be a tool

## 3 image {#image}

{{< version 0.2.0 changed >}}

`image` shortcode is an alternative to [`figure` shortcode](../theme-documentation-built-in-shortcodes#figure). `image` shortcode can take full advantage of the dependent libraries of [lazysizes](https://github.com/aFarkas/lazysizes) and [lightgallery.js](https://github.com/sachinchoolur/lightgallery.js).

{{< version 0.2.10 >}} The complete usage of [local resource references](../theme-documentation-content#contents-organization) is supported.
The complete usage of [local resource references](../theme-documentation-content#contents-organization) is supported.

The `image` shortcode has the following named parameters:

Expand Down Expand Up @@ -253,7 +247,7 @@ The `admonition` shortcode has the following named parameters:

Title of the `admonition` banner, default value is the value of **type** parameter.

- **open** _[optional]_ (**third** positional parameter) {{< version 0.2.0 changed >}}
- **open** _[optional]_ (**third** positional parameter)

Whether the content will be expandable by default, default value is `true`.

Expand Down Expand Up @@ -905,16 +899,14 @@ The `echarts` shortcode has also the following named parameters:

- **width** _[optional]_ (**first** positional parameter)

{{< version 0.2.0 >}} Width of the data visualization, default value is `100%`.
Width of the data visualization, default value is `100%`.

- **height** _[optional]_ (**second** positional parameter)

{{< version 0.2.0 >}} Height of the data visualization, default value is `30rem`.
Height of the data visualization, default value is `30rem`.

## 7 mapbox

{{< version 0.2.0 >}}

[Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js) is a JavaScript library that uses WebGL to render interactive maps from [vector tiles](https://docs.mapbox.com/help/glossary/vector-tiles/) and [Mapbox styles](https://docs.mapbox.com/mapbox-gl-js/style-spec/).

The `mapbox` shortcode has the following named parameters to use Mapbox GL JS:
Expand Down Expand Up @@ -999,7 +991,7 @@ There are three ways to use it the `music` shortcode.

### 8.1 Custom Music URL {#custom-music-url}

{{< version 0.2.10 >}} The complete usage of [local resource references](../theme-documentation-content#contents-organization) is supported.
The complete usage of [local resource references](../theme-documentation-content#contents-organization) is supported.

The `music` shortcode has the following named parameters by custom music URL:

Expand Down Expand Up @@ -1088,7 +1080,7 @@ The `music` shortcode has other named parameters applying to the above three way

- **theme** _[optional]_

{{< version 0.2.0 changed >}} Main color of the music player, default value is `#448aff`.
Main color of the music player, default value is `#448aff`.

- **fixed** _[optional]_

Expand Down Expand Up @@ -1134,8 +1126,6 @@ The `music` shortcode has the following named parameters only applying to the ty

## 9 bilibili

{{< version 0.2.0 changed >}}

The `bilibili` shortcode embeds a responsive video player for bilibili videos.

When the video only has one part, only the BV `id` of the video is required, e.g.:
Expand Down Expand Up @@ -1272,8 +1262,6 @@ The rendered output looks like this:

## 11 script

{{< version 0.2.8 >}}

`script` is a shortcode to insert custom **:(fab fa-js fa-fw): Javascript** in your post.

{{< admonition >}}
Expand Down
Loading

0 comments on commit 1c82984

Please sign in to comment.