Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
* dev:
  Chore: 更新主题 (hugo-fixit/FixIt#490)
  Docs: 更新文章导航配置 (hugo-fixit/FixIt#480)
  Chore: 详细显示 FixIt 的具体版本
  Docs: 完整支持 typeit shortcode (hugo-fixit/FixIt#483)
  • Loading branch information
Lruihao committed Aug 24, 2024
2 parents afc68ee + 2f9b51d commit 13c67e5
Show file tree
Hide file tree
Showing 16 changed files with 220 additions and 147 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/algolia-atomic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
ALGOLIA_APP_ID: YKOM6PKLUY
ALGOLIA_ADMIN_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
ALGOLIA_INDEX_NAME: "index.en"
ALGOLIA_INDEX_FILE: "./public/index.json"
ALGOLIA_INDEX_FILE: "./public/search.json"
run: |
npm run algolia
Expand All @@ -50,6 +50,6 @@ jobs:
ALGOLIA_APP_ID: YKOM6PKLUY
ALGOLIA_ADMIN_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
ALGOLIA_INDEX_NAME: "index.zh-cn"
ALGOLIA_INDEX_FILE: "./public/zh-cn/index.json"
ALGOLIA_INDEX_FILE: "./public/zh-cn/search.json"
run: |
npm run algolia
2 changes: 1 addition & 1 deletion assets/js/custom.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class FixItDocs {
// set header subtitle with theme version (desktop and mobile)
const headerSubtitles = document.querySelectorAll('.header-subtitle');
headerSubtitles.forEach((subtitle) => {
subtitle.textContent = `${themeVersion}`;
subtitle.textContent = `${themeVersion.replace(/-.*$/, '*')}`;
});
return this;
}
Expand Down
4 changes: 3 additions & 1 deletion config/_default/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ capitalizeListTitles = false
ignoreLogs = [
"error-get-remote-image",
"error-get-remote-json",
"error-get-gh-repo",
"error-remote-getjson",
"error-missing-instagram-accesstoken",
"err-youtube-remote"
"err-youtube-remote",
"warning-dev-version"
]
47 changes: 0 additions & 47 deletions config/_default/outputFormats.toml

This file was deleted.

22 changes: 12 additions & 10 deletions config/_default/outputs.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@
# See: https://gohugo.io/templates/output-formats/#customizing-output-formats
# -------------------------------------------------------------------------------------

_merge = "shollow"

# Options to make hugo output files, the optional values are below:
# 用于 Hugo 输出文档的设置,可选值如下:
# home: ["HTML", "RSS", "JSON", "archives", "offline", "README", "baidu_urls"]
# page: ["HTML", "MarkDown"]
# section: ["HTML", "RSS"]
# taxonomy: ["HTML", "RSS"]
# term: ["HTML", "RSS"]
home = ["HTML", "RSS", "JSON", "archives", "offline", "README", "baidu_urls"]
page = ["HTML", "MarkDown"]
section = ["HTML", "RSS"]
taxonomy = ["HTML"]
term = ["HTML", "RSS"]
# home = ["html", "rss", "archives", "offline", "readme", "baidu_urls", "search"]
# page = ["html", "markdown"]
# section = ["html", "rss"]
# taxonomy = ["html"]
# term = ["html", "rss"]
home = ["html", "rss", "archives", "offline", "readme", "baidu_urls", "search"]
page = ["html", "markdown"]
section = ["html", "rss"]
taxonomy = ["html"]
term = ["html", "rss"]
56 changes: 41 additions & 15 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ enablePWA = true
# FixIt 0.2.14 | NEW whether to add external Icon for external links automatically
# FixIt 0.2.14 | 新增 是否自动显示外链图标
externalIcon = true
# FixIt 0.3.0 | NEW whether to reverse the order of the navigation menu
# FixIt 0.3.0 | 新增 是否反转导航菜单的顺序
navigationReverse = true
# FixIt 0.3.0 | NEW whether to add site title to the title of every page
# remember to set up your site title in `hugo.toml` (e.g. title = "title")
# FixIt 0.3.0 | 新增 是否在每个页面标题中添加网站标题
Expand All @@ -45,7 +42,7 @@ titleDelimiter = "|"
# remember to set up your site subtitle by `params.header.subtitle.name`
# FixIt 0.3.0 | 新增 是否在主页标题中添加网站副标题
# 请记得通过 `params.header.subtitle.name` 设置网站副标题
indexWithSubtitle = false
indexWithSubtitle = true
# FixIt 0.2.14 | NEW FixIt will, by default, inject a theme meta tag in the HTML head on the home page only.
# You can turn it off, but we would really appreciate if you don’t, as this is a good way to watch FixIt's popularity on the rise.
# FixIt 0.2.14 | 新增 默认情况下,FixIt 只会在主页的 HTML 头中注入主题元标记。
Expand Down Expand Up @@ -171,7 +168,7 @@ disableThemeInject = false
[header.subtitle]
# subtitle name
# 副标题名称
name = ""
name = "Theme for Hugo"
# whether to use typeit animation for subtitle name
# 是否为副标题显示打字机动画
typeit = false
Expand All @@ -183,6 +180,16 @@ disableThemeInject = false
sticky = true
showHome = false

# FixIt 0.3.10 | NEW Post navigation config
# FixIt 0.3.10 | 新增 文章导航配置
[navigation]
# whether to show the post navigation in section pages scope
# 是否在 section 页面范围内显示文章导航
inSection = false
# whether to reverse the next/previous post navigation order
# 是否反转 下一篇/上一篇 文章导航顺序
reverse = false

# Footer config
# 页面底部信息配置
[footer]
Expand Down Expand Up @@ -240,9 +247,15 @@ disableThemeInject = false
# date format (month and day)
# 日期格式 (月和日)
dateFormat = "01-02"
# amount of RSS pages
# RSS 文章数目
rss = 10
# FixIt 0.3.10 | NEW Section feed config for RSS, Atom and JSON feed.
# FixIt 0.3.10 | 新增 Section feed 配置用于 RSS, Atom 和 JSON feed。
[section.feed]
# The number of posts to include in the feed. If set to -1, all posts.
# 包含在 feed 中的文章数目。如果设置为 -1,代表所有文章。
limit = -1
# whether to show the full text content in feed.
# 是否在 feed 中显示全文内容。
fullText = false
# FixIt 0.2.13 | NEW recently updated posts settings
# FixIt 0.2.13 | 新增 最近更新文章设置
[section.recentlyUpdated]
Expand All @@ -260,9 +273,15 @@ disableThemeInject = false
# date format (month and day)
# 日期格式 (月和日)
dateFormat = "01-02"
# amount of RSS pages
# RSS 文章数目
rss = 10
# FixIt 0.3.10 | NEW Term list feed config for RSS, Atom and JSON feed.
# FixIt 0.3.10 | 新增 Term list feed 配置用于 RSS, Atom 和 JSON feed。
[list.feed]
# The number of posts to include in the feed. If set to -1, all posts.
# 包含在 feed 中的文章数目。如果设置为 -1,代表所有文章。
limit = -1
# whether to show the full text content in feed.
# 是否在 feed 中显示全文内容。
fullText = false

# TagCloud config for tags page
# 标签云配置
Expand Down Expand Up @@ -634,6 +653,16 @@ disableThemeInject = false
# "corner-indicator", "fill-left", "flash", "flat-top", "loading-bar", "mac-osx", "material", "minimal"]
theme = "minimal"

# FixIt 0.3.10 | NEW Global Feed config for RSS, Atom and JSON feed.
# FixIt 0.3.10 | 新增 全局 Feed 配置用于 RSS, Atom 和 JSON feed。
[feed]
# The number of posts to include in the feed. If set to -1, all posts.
# 包含在 feed 中的文章数目。如果设置为 -1,代表所有文章。
limit = 10
# whether to show the full text content in feed.
# 是否在 feed 中显示全文内容。
fullText = true

# FixIt 0.2.15 | NEW Developer options
# FixIt 0.2.15 | 新增 开发者选项
# Select the scope named `public_repo` to generate personal access token,
Expand Down Expand Up @@ -673,7 +702,7 @@ disableThemeInject = false
hiddenFromSearch = false
# FixIt 0.3.0 | NEW whether to hide a page from RSS feed
# FixIt 0.3.0 | 新增 是否在 RSS 中隐藏一篇文章
hiddenFromRss = false
hiddenFromFeed = false
# FixIt 0.3.0 | NEW whether to hide a page from related posts
# FixIt 0.3.0 | 新增 是否在相关文章中隐藏一篇文章
hiddenFromRelated = false
Expand Down Expand Up @@ -711,9 +740,6 @@ disableThemeInject = false
# whether to show link to report issue for the post
# 是否显示报告文章问题的链接
linkToReport = true
# whether to show the full text content in RSS
# 是否在 RSS 中显示全文内容
rssFullText = false
# FixIt 0.3.10 | CHANGED Page style ["narrow", "normal", "wide", ...)
# FixIt 0.3.10 | 更改 页面样式 ["narrow", "normal", "wide", ...)
pageStyle = "normal"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ hugo new --kind post-bundle posts/bar/
- **hiddenFromHomePage**: if `true`, the content will not be shown in the home page.
- **hiddenFromSearch**: if `true`, the content will not be shown in the search results.
- **hiddenFromRss**: {{< version 0.2.18-lts.5 >}} if `true`, the content will not be shown in the RSS feed.
- **hiddenFromRelated**: {{< version 0.3.0 >}} if `true`, the content will not be shown in the related posts.
- **hiddenFromFeed**: {{< version 0.3.10 >}} if `true`, the content will not be shown in the RSS, Atom and JSON feed.
- **twemoji**: if `true`, the content will enable the twemoji.
- **lightgallery**: {{< version 0.2.18 changed >}} the same as the `params.page.lightgallery` part in the [theme configuration][theme-config].
- **ruby**: if `true`, the content will enable the [ruby extended syntax][extended-markdown-syntax].
Expand All @@ -153,7 +153,6 @@ hugo new --kind post-bundle posts/bar/
- **linkToSource**: {{< version 0.3.0 >}} if `true`, the footer of the content will be shown the link to the source file.
- **linkToEdit**: {{< version 0.3.0 >}} if `true`, the footer of the content will be shown the link to the edit page.
- **linkToReport**: {{< version 0.3.0 >}} if `true`, the footer of the content will be shown the link to the report issue.
- **rssFullText**: if `true`, the full text content will be shown in RSS.
- **pageStyle**: {{< version 0.2.13 >}} Detail see [Page Style][page-style].

- **toc**: the same as the `params.page.toc` part in the [theme configuration][theme-config].
Expand All @@ -179,6 +178,7 @@ hugo new --kind post-bundle posts/bar/
- **endFlag**: {{< version 0.2.17 >}} the same as the `params.page.endFlag` part in the [theme configuration][theme-config].
- **reward**: {{< version 0.2.17 >}} the same as the `params.page.reward` part in the [theme configuration][theme-config].
- **instantPage**: {{< version 0.2.18 >}} the same as the `params.page.instantPage` part in the [theme configuration][theme-config].
- **feed**: {{< version 0.3.10 >}} the same as the `params.feed` part in the [theme configuration][theme-config].

<!-- front matter for section only -->

Expand Down Expand Up @@ -229,7 +229,6 @@ ruby: true
fraction: true
fontawesome: true
linkToMarkdown: true
rssFullText: false
pageStyle: "normal"
toc:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,25 @@ The `typeit` shortcode has the following named parameters:

Grouping of content, the content of the same group will start typing animation in order.

- **speed** _[optional]_

{{< version 0.3.10 >}} Typing speed between each step (measured in milliseconds), default: `100`.

- **cursorSpeed** _[optional]_

{{< version 0.3.10 >}} Blinking speed of the cursor (measured in milliseconds), default: `1000`.

- **cursorChar** _[optional]_

{{< version 0.3.10 >}} Character used for the cursor (HTML format is supported), default: `|`.

- **duration** _[optional]_

{{< version 0.3.10 >}} Cursor duration after typing finishing (measured in milliseconds, `-1` means unlimited), default: `-1`.

- **loop** _[optional]_

Whether your content will continuously loop after completing.
{{< version 0.2.18 >}} Whether your content will continuously loop after completing.

## Simple Content {#simple-content}

Expand Down
Loading

0 comments on commit 13c67e5

Please sign in to comment.