heige-pcloud/doit

A clean, elegant and advanced blog theme for Hugo.

doit's Issues

[FEATURE] 点击图片能看大图

• 点击图片能看大图
  大佬有空看看能不能加上这个功能，就是文章里的图片，点一下能看大图

[ENHANCEMENT] Optimize SEO

Use <button> instead of <a> tag and javascript:void(0) to make SEO happy.

[CHORE] Update libs

Attempt to upgrade some libs.

[FEATURE] Some feature：支持文章图片点击放大

Describe the feature you want 描述你的功能需求

当文章添加了一些分辨率比较高的图片时，因为无法点击放大图片，观看上会略有难受。如果能支持此功能，体验会好很多。

Useful reference 有价值的参考

If available, provide useful links to fulfill the feature.
如果可以的话, 提供实现这个功能的相关参考链接.
1、一个点击图片放大显示的案例：https://blog.keyboardman.fun/share/1291.html

[BUG] Scrolling the headings behind the header

Reference: how to prevent anchor links from scrolling behind fixed or sticky headers

[FEATURE] 加入 fusejs 进行搜索

Describe the feature you want 描述你的功能需求

在中文环境下，使用 fusejs 似乎比 lunrjs 更友好。
这个是例子 https://themes.gohugo.io/hugo-theme-zdoc/

Useful reference 有价值的参考

https://fusejs.io/

[Accessibility] Need to improve the link color under dark mode

Background and link colors do not have a sufficient contrast ratio in dark mode.

[FEATURE] 文章置顶功能

Describe the feature you want 描述你的功能需求

• Feature 1 文章置顶功能

Useful reference 有价值的参考

不知是否存在，但是没有搜索到

[FEATURE] Different Style for TOC

The max-width: 800px setting on the article element leaves a lot of blank space on a wide screen. The position and margin of TOC and article need some redesigns.

Different styles can be left as a setting which can be switched by the user manually for each post or entire site, or it can be adjusted by the reader with a button.

[FEATURE] 友情链接卡片

Describe the feature you want 描述你的功能需求

• Feature 功能需求 友情链接卡片

Useful reference 有价值的参考

https://9lewl.com/Friends.html

https://bore.vip/archives/hugo-theme-LoveIt/
（根据这个链接，本主题不显示图片）

[FEATURE] DoIt 支持百度统计吗

Describe the feature you want 描述你的功能需求

DoIt 支持百度统计吗

[FEATURE] Switch Theme Drop-down menu

Describe the feature you want

• A drop down menu for user to choose between different color themes between “black", "dark", "light", "auto".

Useful reference

The change theme button of the Eureka theme is a good example.

https://www.wangchucheng.com/en/docs/hugo-eureka/

[BUG] Multiple Line Block Math Formula is not rendered

Describe the bug 描述你遇到的错误

I have a KaTex formula as follows:

$$
\begin{aligned}
2 \times Area(a, b, c) =
\begin{vmatrix}
a_x & a_y & 1\\
b_x & b_y & 1\\
c_x & c_y & 1\\
\end{vmatrix}
= \\
\begin{vmatrix}
b_x - a_x & b_y - a_y \\
c_x - a_x & c_y - a_y \\
\end{vmatrix}
\end{aligned}
$$

It should be rendered as the screenshot shows, but it didn't, just stay the same.

Expected behavior 期待的行为

It should be rendered as the screenshot shows.

Screenshots 屏幕截图

Build Environment 构建环境

• OS: Manjaro
• Theme version/commit b3dc66e
• Hugo version hugo v0.83.1-5AFE0A57+extended linux/amd64 BuildDate=2021-05-02T14:38:05Z VendorInfo=gohugoio

Please try to use Hugo extended version before opening the issue.
请在创建 issue 之前尝试使用 Hugo extended 版本.

Preview Environment 预览环境

• OS: Manjaro
• Browser Firefox

Additional Information 补充信息

Configuration files or front matter code...
配置文件或者前置参数的代码...

Just the same as the theme docs.

[FEATURE] Add Portfolio/Show case

Describe the feature you want 描述你的功能需求

• Add page of Projects or Portfolio
  Like a page or a section on the home page showing some of the projects(could be a post) :-)

Thank you PCloud for taking over loveit!

I really liked what's offered by loveit/doit and its design language, I am planning to mitigate the "projects" with some markdown tables in a post named projects.md for now, just would like to check with you on whether it could be supported ;-)

Useful reference 有价值的参考

Something like https://rjordaney.is/lectures/ with the https://github.com/PippoRJ/hugo-refresh ?

If available, provide useful links to fulfill the feature.
如果可以的话, 提供实现这个功能的相关参考链接.

N/A

[CHORE] Update Theme Documentation

Adapt theme documentation from LoveIt to DoIt

Add documentation on configuring PWA

[BUG] Search box doesn't open after page transition.

Describe the bug 描述你遇到的错误

After page transition, clicking a search icon doesn't open search box.

Expected behavior 期待的行为

Search box should open when I click the icon even after page transition.

Build Environment 构建环境

• OS: Arch Linux
• Theme commit: 8048c36
• hugo v0.85.0+extended linux/amd64 BuildDate=unknown

Preview Environment 预览环境

• OS: Windows10
• Vivaldi 4.0.2312.33 (Stable channel) (64-bit)

Additional Information 补充信息

• In my preview environment, this problem happens too in hugodoit.pages.dev.
• Setting relativeURLs and canonifyURLs to true didn't solve the issue.

Maybe it's hard to read because I speak neither Chinese nor English. Thank you.

[FEATURE] Add support for waline comment system

https://github.com/lizheming/waline

A better comment system than Valine.

[FEATURE] Black Theme

Describe the feature you want

• Provide a complete black theme

The current dark mode is a grey theme, which does not look very well on OLED display. A complete black theme with black background will help saving power and makes it look better in some ways.

Useful reference

The black theme of Twitter is a good example.

[BUG] Issue with the `wide` style

Issue with the wide style. When the TOC is turned off, the article body is not in the middle.

[BUG] failed to render pages: render

render 报错
hugo version
hugo v0.82.0+extended linux/amd64 BuildDate=unknown

Error: Error building site: failed to render pages: render of "page" failed: execute of template failed: template: posts/single.html:103:124: executing "content" at <partial "function/content.html">: error calling partial: "/home/yanboyang713/yanboyang713.github.io/themes/DoIt/layouts/partials/function/content.html:4:19": execute of template failed: template: partials/function/content.html:4:19: executing "partials/function/content.html" at <partial "function/ruby.html" $content>: error calling partial: partial that returns a value needs a non-zero argument.

解决方法：
https://blog.mrsheep.xyz/posts/loveit-error-fix/

[疑问] 为什么自定义样式无效呢

Describe the bug 描述你遇到的错误

我修改了 themes\DoIt\assets\css_custom.scss ，但是不生效

A clear and concise description of what the bug is.
一段简短的对于你遇到的错误的描述.
我将 themes\DoIt\assets\css_custom.scss 内容修改为下面的代码，我想尝试调整一下行间距，但是发现无效。

.single {
    .content {
        p {
            margin: 1.5rem 0;
        }
    }
}

是我哪里操作不对吗？在试错过程中，我也尝试在根目录下新建了一个 assets\css_custom.scss 文件，写入了相同的样式，但是依然无效。文档我看过了，但是没有看明白是什么意思。

[BUG] The Instagram Shortcode has an API error

https://khusika.com/instagram-shortcode-in-hugo/

[FEATURE] Add support for twikoo comment system

Twikoo seems to be a powerful comment system. But it does not have English language support and require Tecent Cloudbase. It seems that they are working on Vercel deployment support. I will keep looking into it and add support for twikoo comment when it's ready.

[FEATURE] 添加多作者分类

Describe the feature you want 描述你的功能需求

• 文章的 meta 中通过 authors 数组传入多个作者名
  点击作者可以链接到对应作者参与的文章列表。

Useful reference 有价值的参考

https://minimo.netlify.app/docs/katex-support/

我目前正常尝试迁移该功能

迁移功能点

• 参考 minimo 的相关逻辑，点击作者名后进入作者及文章列表。
• 在作者列表页面修改作者名链接到自定义链接。
• 如果作者信息没有单独录入，则使用 config 配置，以保持兼容性。

需要的帮助

本人非前端开发人员，对于样式方面修改需要一定支持或协助。

望反馈！

[FEATURE] 增加 Series 相关页面

Describe the feature you want 描述你的功能需求

增加 Taxonomy 为 Series 的相关页面。

需求逻辑：

Series 即系列，是博客中高质量文章的体系汇总，相比【分类】和【标签】，其文章质量更高。

自己的博客有系列文章的话也更容易提高博客的知名度和质量。

下面会稍微详细的描述这个需求

• Feature 1 功能需求 1
  增加一个 Series 分类，类似于 Category，但是可以通过读取 series 下的 _index.md 在 list 之前增加简介内容
• Feature 2 功能需求 2
  增加一个与 Categories 类似的 Series 汇总界面

Useful reference 有价值的参考

暂时没有，但我感觉采用卡片式可能会比较好？

If available, provide useful links to fulfill the feature.
如果可以的话, 提供实现这个功能的相关参考链接.

[BUG] 标题的打字效果有BUG

Describe the bug 描述你遇到的错误

BUG如图所示

Screenshots 屏幕截图

Build Environment 构建环境

• OS: [e.g. macOS]
• Theme version master最新
• Hugo Static Site Generator v0.80.0/extended darwin/amd64 BuildDate: unknown

[DOCUMENTATION] Optimize documentation site

Several things need to be improved.

1. Need to add explicit height and width to all pictures.
2. Need to improve the punctuation of the Chinese site.
3. Need to update the French site.

[BUG] Some problem...

Describe the bug 描述你遇到的错误

Build failed

Screenshots 屏幕截图

Build Environment 构建环境

vercel

[FEATURE] 更换Researchgate图标

Describe the feature you want 描述你的功能需求

• Feature 更换Researchgate图标，别的社交媒体都是圆角，RG是直角
• ...

Useful reference 有价值的参考

If available, provide useful links to fulfill the feature.
如果可以的话, 提供实现这个功能的相关参考链接.

[minor] consider promoted via themes.gohugo.io ?

What I did to decide which framework/theme to use was to scan all themes from the official theme catalog, for Hugo it's https://themes.gohugo.io.

Thank God I came here from Loveit's issues. I don't think everyone is as lucky as me.

Would you consider put doit on https://themes.gohugo.io?

Thanks again for the awesome work!

[BUG] The mermaid graph has rendering error

https://hugodoit.pages.dev/theme-documentation-extended-shortcodes/#5-mermaid

Cannot display correctly.

The issue happens to classDiagram and gitGraph.

[BUG] Valine and Waline issues regarding visit statistics

Describe the bug

I tested the Valine and Waline plugins separately to see if the visit statistics worked well. On my side, it only showed the eye symbol and didn't have the number, not even with 0. Everything goes well when I tested on Twikoo.

Expected behavior

Show the visit number.

Screenshots

Build Environment

• OS: Windows 10, iPadOS
• Theme version/commit: 0af16e1
• Hugo version: v0.84.4-020E4ACE+extended

Preview Environment

https://www.imzluo.com/deepspeed/

Additional Information

[params.page.comment.valine]
  enable = true
  appId = "aM7gLUeWp8it1Efrcp3rm8TB-MdYXbMMI"
  appKey = "Xn1xlYj3Fm5gvsYG3WyQpaix"
  placeholder = ""
  avatar = "mp"
  meta= ""
  pageSize = 10
  lang = "en"
  visitor = true
  recordIP = true
  highlight = true
  enableQQ = false
  serverURLs = ""

Other

For the comment plugins, can we only enable the visit statistics and disable the comment part at the end of each post?

[BUG] Image elements do not have explicit width and height

Reference: https://web.dev/optimize-cls

Related file: \layouts\partials\plugin\image.html

The large CLS caused by the featured picture will let smooth scroll fail to go to the correct place.

[BUG] featured images path was not rendered properly on windows browsers

Describe the bug 描述你遇到的错误

It's found on windows (firefox, edge) that the featured images on the home page suffered from 404.
It worked well on macOS for all browsers, thus this issue seemed to exist for a long time.
Am I doing it wrong? or something wrong in lazy load part or?

Expected behavior 期待的行为

Browser should display this picture from alt rather than data-src, while it seemed to go for data-src only and 404 encouterred :(

<a href="/nebula-operator-kind/" aria-label=Nebula&#32;Operator&#32;Kind，一键单机玩转&#32;Nebula&#32;K8s&#32;集群><img
        class="lazyload"
        data-src="featured-image.webp"
        data-srcset="/nebula-operator-kind/featured-image.webp, featured-image.webp 1.5x, /nebula-operator-kind/featured-image.webp 2x"
        data-sizes="auto"
        alt="/nebula-operator-kind/featured-image.webp"
        title="无需依赖，一键安装尝鲜基于 Nebula Operator 的 K8s Nebula Graph Cluster" height="auto" width="auto"
    />

I am not expert in the frontend, not sure if the wrong behavior I found is the root cause :-p

Screenshots 屏幕截图

Build Environment 构建环境

• OS: [macOS]
• Theme version/commit: b4855ef
• Hugo version: "v0.83.1+extended darwin/arm64 BuildDate=unknown"

Preview Environment 预览环境

• OS: [Windows 10]
• Browser [Edge, Firefox]

Additional Information 补充信息

Can be checked from siwei.io in a windows machine.

post head in index.md

---
...
featuredImage: "featured-image.webp"
featuredImagePreview: "featured-image.webp"
---

[BUG] 你们都是把你们的blog部署在那里？github pages？

你们都是把你们的blog部署在那里？github pages？

我在本地
hugo server -D
显示都比较正常。
本地hugo version
hugo v0.82.0+extended linux/amd64 BuildDate=unknown

用github action build 时会报错， 用的是hugo v0.83.1：

Run hugo --minify
Start building sites …
WARN 2021/05/03 02:59:10 found no layout file for "HTML" for kind "home": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2021/05/03 02:59:10 found no layout file for "HTML" for kind "taxonomy": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2021/05/03 02:59:10 found no layout file for "HTML" for kind "taxonomy": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2021/05/03 02:59:10 found no layout file for "JSON" for kind "home": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.

               | EN  

-------------------+-----
Pages | 1
Paginator pages | 0
Non-page files | 0
Static files | 0
Processed images | 0
Aliases | 0
Sitemaps | 1
Cleaned | 0

Total in 12 ms

Run peaceiris/actions-hugo@v2
Hugo version: 0.83.1
/bin/tar xz --warning=no-unknown-keyword -C /home/runner/actions_hugo/_temp -f /home/runner/work/_temp/1f5aa5ce-210c-405b-8079-8f5c15ffbef9
/home/runner/actions_hugo/bin/hugo version
hugo v0.83.1-5AFE0A57+extended linux/amd64 BuildDate=2021-05-02T14:38:05Z VendorInfo=gohugoio

[BUG] 设置 Permalinks 规则后，<site>/categories 页面中的 URL 没有变化

Describe the bug 描述你遇到的错误

A clear and concise description of what the bug is.
一段简短的对于你遇到的错误的描述.
我将 Permalinks 设置为如下规则

[Permalinks]
  posts= "/:section/:slug"

并且开启了伪静态

uglyurls = true

但 /categories 页面中的 URL 没有做出相应的改变，仍然保持原样。

但首页（ ）的 URL 已经根据我的设置做出了相应改变。对此我感到很困惑，这是否是正常的行为？

我在 issue 中搜索了相关问题，但没有找到类似的回答。

A possible friend links layout

I also copy from other guys, but I forget to save the author's link. If there's infringement, please tell me, since I can't contact with the author.
My friend links webpage

[BUG] code block 命令行溢出

Describe the bug 描述你遇到的错误

code block 命令行溢出

Expected behavior 期待的行为

code block 可以滑动

Screenshots 屏幕截图

Build Environment 构建环境

• OS: ArchLinux
• Theme version/commit [latest]
• Hugo version [latest]

Please try to use Hugo extended version before opening the issue.
请在创建 issue 之前尝试使用 Hugo extended 版本.

Preview Environment 预览环境

• OS: ArchLinux
• Theme version/commit [latest]
• Hugo version [latest]

Additional Information 补充信息

[BUG] Error: Error building site: failed to render pages: render of "page" failed

Describe the bug

I was trying to build the example website. I created a new site, cloned the repo, and copied everything from E:\IMZLUO\themes\DoIt\exampleSite to E:\IMZLUO\.

Expected behavior

The example site should have been built successfully.

Screenshots

E:\IMZLUO>hugo serve --disableFastRender
Start building sites …
hugo v0.84.4-020E4ACE+extended windows/amd64 BuildDate=2021-07-01T11:51:55Z VendorInfo=gohugoio
WARN 2021/07/04 00:09:35

Current environment is "development". The "comment system", "PWA", "CDN" and "fingerprint" will be disabled.
当前运行环境是 "development". "评论系统", "PWA", "CDN" 和 "fingerprint" 不会启用.
Built in 30626 ms
Error: Error building site: failed to render pages: render of "page" failed: execute of template failed: template: posts/single.html:122:124: executing "content" at <partial "function/content.html">: error calling partial: "E:\IMZLUO\themes\DoIt\layouts\partials\function\content.html:6:23": execute of template failed: template: partials/function/content.html:6:23: executing "partials/function/content.html" at <partial "function/ruby.html" $content>: error calling partial: partial that returns a value needs a non-zero argument.

Build Environment

• OS: Windows 10
• Theme version/commit: ee866f9
• Hugo version: v0.84.4-020E4ACE+extended

Preview Environment

N/A

Additional Information

N/A

[ENHANCEMENT] The horizontal rules need to be more conspicuous

The current style of horizontal rules (triggered by ___, ---, ***) is horrible and makes it indistinguishable at all. It need to be thicker with a different color.

[Bug] 竖屏显示标题栏网站标题位置需要调整一下

Expected behavior 期待的行为

竖屏的时候网站标题位置有点奇怪，希望可以更靠左一些

Screenshots 屏幕截图

Create Changelog for v0.2.11

Currently, the commit message is a mess and does not follow any guidelines which makes auto generating tools unusable. For this release, the changelog needs to be written and checked by hand.

Need to pick a changelog generator and list the rules for commit message in CONTRIBUTING.md.

[BUG] 设置 Permalinks 规则后，<site>/categories 页面中的 URL 没有变化

Describe the bug 描述你遇到的错误

A clear and concise description of what the bug is.
一段简短的对于你遇到的错误的描述.
我将 Permalinks 设置为如下规则

[Permalinks]
  posts= "/:section/:slug"

并且开启了伪静态

uglyurls = true

但 /categories 页面中的 URL 没有做出相应的改变，仍然保持原样。

但首页（ 网站根目录 ）的 URL 已经根据我的设置做出了相应改变。对此我感到很困惑，这是否是正常的行为？

我在 issue 中搜索了相关问题，但没有找到类似的回答。

[FEATURE] Some feature：支持pjax刷新

Describe the feature you want 描述你的功能需求

你好，我最近遇到了一些棘手的问题，在我使用APlayer音乐播放器当作背景音乐时，当我点击主题的其他地方，音乐就会刷新并重新播放，这种体验很糟糕。也让我很苦恼，当我去寻找解决方法是发现使用PJAX可以完美解决我的问题，我还发现hexo最热门的那几个主题同样使用了PJAX，比如next、butterfly、sakura、material-x等等主题。

使用pjax的体验很好，在点击其它地方时，比如footer、header这些可以不用重复加载，减少服务器压力，提高加载速度，提升用户体验。

pjax具有以下优点：
按需请求，每次只需加载页面的部分内容，而不用重复加载一些公共的资源文件和不变的页面结构，大大减小了数据请求量，以减轻对服务器的带宽和性能压力，还大大提升了页面的加载速度
常规页面跳转需要重新加载画面上的内容，会有明显的闪烁，而且往往和跳转前的页面没有连贯性，用户体验不是很好。如果再遇上页面比较庞大、网速又不是很好的情况，用户体验就更加雪上加霜了。使用pjax后，由于只刷新部分页面，切换效果更加流畅，而且可以定制过度动画，在等待页面加载的时候体验就比较舒服了。

Useful reference 有价值的参考

If available, provide useful links to fulfill the feature.
如果可以的话, 提供实现这个功能的相关参考链接.
1.pjax使用小结：https://www.jianshu.com/p/557cad38e7dd
2.让你的网站实现 pjax 无刷新：https://paugram.com/coding/add-pjax-to-your-website.html
3.这是一个运用了pjax的hugo主题：https://github.com/vvc-Dream/hugo-maupassant-pjax

[BUG] 默认样式设置无效

defaultTheme = "dark"

我想把默认样式设置成“暗色”，无效

[BUG] Search index is still on LoveIt

Describe the bug 描述你遇到的错误

The search index of https://hugodoit.pages.dev/ is still on LoveIt.

Expected behavior 期待的行为

The Algolia search index should be updated to the contents of DoIt theme.

Screenshots 屏幕截图

Build Environment 构建环境

https://github.com/HEIGE-PCloud/DoIt

Preview Environment 预览环境

On the latest Chrome, Windows 10.

Additional Information 补充信息

To update the search index, you might want to sign up and create an Algolia app to hold the entries.

FYI, I wrote a CI pipeline to upload the search index upon pushing to the main branch. Also, here are the relevant npm package and the lock files.

Some customizations might be needed, such as:

• API keys
• one search index for each language.

Reference:

• https://coldinfire.github.io/2018/Utils_hugo2/

[BUG] Contents被转移到头部而不是侧边栏

Describe the bug 描述你遇到的错误

Contents被转移到头部而不是侧边连

Expected behavior 期待的行为

Contents转移到侧边栏

Screenshots 屏幕截图

Build Environment 构建环境

• OS: [ArchLinux]
• Theme version/commit [latest]
• Hugo version [latest]

Please try to use Hugo extended version before opening the issue.
请在创建 issue 之前尝试使用 Hugo extended 版本.

Preview Environment 预览环境

• OS: [ArchLinux]
• Theme version/commit [latest]
• Hugo version [latest]

Additional Information 补充信息

Configuration files or front matter code...
配置文件或者前置参数的代码...

Add DoIt theme to hugoThemes

As v0.2.11 release will be the first release from DoIt theme, I plan to add the DoIt theme to hugo official theme site so more people can discover this theme. There are still some work to do to optimize the theme to meet the requirements.

Here are the requirements: https://github.com/gohugoio/hugoThemes/blob/master/README.md

[FEATURE] Update the custom style for Waline and Valine comment system

The current style for both comment system is just rubbish.

Need some rewrite to Waline.scss and valine.scss.