Skip to content

qinchende/maupassant-hugo

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

142 Commits

archetypes

archetypes

 
 

exampleSite

exampleSite

 
 

layouts

layouts

 
 

static

static

 
 

.gitignore

.gitignore

 
 

LICENSE.md

LICENSE.md

 
 

README.md

README.md

 
 

preview.png

preview.png

 
 

theme.toml

theme.toml

 
 

Repository files navigation

Maupassant

Maupassant theme, ported to Hugo.

预览效果：闪电侠的小黑板

一款非常简洁、性能极高的Hugo主题，自适应不同的设备（PC，Mobile等）（自动调整显示模块）。

说明

  1. 闪电侠的小黑板 从飞雪无情 的博客样式forked，做了些样式的修改，功能的调整。
  2. 飞雪无情的博客 主要是基于 Typecho Cho, 从 JokerQyou forked，修改和添加了很多功能而成，如GA统计、最近的文章、标签云、自定义菜单、按日期归档等 .

Preview

Maupassant 主题预览

功能特性

  1. 支持Local Search站内搜索
  2. 最近发表的文章支持，显示最近的12篇
  3. 分类支持，并且可以显示分类内的文章数量
  4. 标签云支持
  5. 文章目录支持
  6. 一键回到页面顶部
  7. 支持关键字SEO优化
  8. 自定义菜单支持，不限个数，自定义排序
  9. 自定义友情链接支持
  10. 支持文章按年份日期进行归档
  11. 支持GA分析统计
  12. 不蒜子页面计数器支持
  13. 代码高亮、代码行号
  14. sitemap站点地图
  15. RSS支持，并且可以自动发现RSS
  16. Google站内搜索
  17. See Also 支持
  18. 自定义css、js
  19. Disqus评论支持
  20. utteranc评论
  21. 部分自定义的shortcode
  22. 文章自定义摘要
  23. 自定义广告支持
  24. 自定义备案信息
  25. 自定义图片CDN
  26. 图片点击放大
  27. 发布带.html后缀的页面

下载安装

cd <Your bolg root dir>
git clone https://github.com/qinchende/maupassant-hugo themes/maupassant

配置

依赖要求

Hugo Version >= v 0.78.2

应用主题

theme = "maupassant"

快速开始

在主题的 exampleSite 示例目录下有config.toml 文件，把config.toml 文件复制到你的站点目录下，然后根据自己的需求修改即可

代码高亮

从Hugo v0.60.0开始，默认使用Goldmark渲染MD文件，并且默认开启了代码高亮，所以该主题原来的代码高亮兼容出现问题， 经过取舍，最终还是选用了Hugo原生的代码高亮方式，去掉了原来主题自带的基于JS的代码高亮。

新的Hugo内置的代码高亮使用非常代码，默认不用任何配置就可以，如果你需要开启行号、或者更换代码样式，可以参考如下配置：

config.toml

[markup]
  [markup.highlight]
    lineNos = true
    style = "github"

更多配合和样式参考:

Configure Markup

Syntax Highlighting

自定义菜单

[menu]
[[menu.main]]
    identifier = "archives"
    name = "归档"
    url = "/archives/"
    weight = 2
[[menu.main]]
    identifier = "idea"
    name = "杂思"
    url = "/idea/"
    weight = 3
[[menu.main]]
    identifier = "licai"
    name = "理财"
    url = "/licai/"
    weight = 4
[[menu.main]]
    identifier = "tools"
    name = "工具"
    url = "/tools/"
    weight = 5
[[menu.main]]
    identifier = "about"
    name = "关于"
    url = "/about/"
    weight = 6

identifier标志符必须是唯一的，不能重复；weight用于排序，值越小越靠前。

文章目录（大纲）

该主题支持文章目录（大纲）,大纲是通过h1~h7标题自动生成，在MD文件里就是##这类标题的标记，这里建议最多使用两层文章目录，而且最好是从h2开始，便于SEO优化。 如果要开启一篇文章的文章目录，只需要在Front Matter 添加toc=true即可，默认是不开启文章目录的。

toc = true

我对文中目录的样式做了修改，移动到右侧边栏悬浮显示（后面还会有进一步修改的计划）

Local Search 站内搜索

站内搜索默认是关闭的，如果需要使用需要以下步骤开启。

  1. 检查config.toml的disableKinds配置项,是否禁用了RSS，如果禁用需要开启。
  2. 在config.toml中找到[params]配置段落，增加localSearch = true开启站内搜索
  3. 在content目录下新建search目录,并且在search目录中新建index.md文件，内容如下
---
title: "搜索"
description: "搜索页面"
type: "search"
---

然后hugo server启动，打开你的站点，就可以在右上角的搜索框里输入关键字进行站内搜索了。

友情链接

[[params.links]]
    title = "闪电侠的小黑板"
    name = "闪电侠的小黑板"
    url = "https://chende.ren"

params.links是一个数组，所以我们可以自定义很多友情链接。name表示显示的链接文本，title表示鼠标悬停在友情链接时，显示的文本。

广告模块

广告模块在侧边栏，可以灵活配置，让博主可以放一些超链接广告、或者图片链接广告。

[[params.ads]]
  title = "领取￥1888阿里云产品通用代金券"
  url = "https://promotion.aliyun.com/ntms/yunparter/invite.html?userCode=jdg9oj97"

params.ads是一个数组，所以我们可以自定义很多广告。如果img存在，则优先使用图片广告,title表示鼠标悬停在广告链接时，显示的文本。

具体效果参考 https://chende.ren

添加GA分析统计

该主题已经支持了最新版本的GA (google analytics)分析统计，只需要在在config.toml的params配置里加入如下配置即可。

googleAnalytics = "GA ID"

文章归档支持

Hugo默认是不支持生成归档文件的，需要自己实现。该主题已经实现了文章归档，只需要在新建content/archives/index.md文件，文件内容为：

title: "归档"
description: Android资深工程师 ，Go和Java打杂师，《Android Gradle权威指南》作者，Android官方技术文档译者
type: archives

title和description都可以换成你自己的，但是type必须是archives。

content/archives/index.md表示在content/archives/目录下的index.md文件

添加备案信息

现在网站要求添加备案信息，本主题也进行了支持，使用方式非常简单，在config.toml的params配置中添加如下设置：

[params]
  beian = "京ICP备XXXXXXX号-1"

以上配置中的备案信息要换成自己的

图片点击放大

将会引入jquery.js 和 fancybox 的css和js

[params]
  fancybox = true

图片CDN

将会在mark中引入的图片src前面加上设置的host, 有http前缀的路径不会在前面加入host 注意: 路径后面不要带/

可直接使用jsdelivr加速 后面跟上github仓库即可

[params.image_cdn]
    enable = true
    Host = "https://cdn.jsdelivr.net/gh/user/user.github.io"

自定义文章摘要

该主题采用了Hugo内置的摘要支持，大家可以通过<!--more-->自定义自己的摘要，也可以使用自动摘要，使用自动摘要时，可以在config.toml中设置摘要的长度

summaryLength参数好像控制的不是太好，我自己又在params下面加了一个参数：summaryLen，同时修改了一些模板代码；摘要的效果更好。

# 默认是70
summaryLength = 140
params.summaryLen = 140

开启版权声明

该主题支持开启版权声明，如果要启用版权声明，可以在config.toml里添加如下配置即可。

[params.cc]
    name = "知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议"
    link = "https://creativecommons.org/licenses/by-nc-nd/4.0/"

其中name和link可以换成自己使用的版权声明协议和链接

See Also显示相关的文章

每篇文章都会有自己的tags, 默认找出第一个tag相同的文章，取与当前文章最近的前后几篇文章显示，同时也会兼顾全局当前文章同时期文章的前一篇和后一篇，整体按创建时间倒叙排列。 可以在config.toml里添加如下配置，指定最多显示多少篇相关文章，默认最多显示8篇。

relatedMaxLen = 8 # 相关文章最多显示

Disqus

该主题支持Disqus评论，如果要启用Disqus，可以在config.toml里添加如下配置即可.

disqusShortname = "yourdiscussshortname"

替换成你自己的Disqus名字即可。

utteranc

该主题支持utteranc评论，这是一个基于Github Issue的评论系统，使用方便，不用翻墙即可评论。 可以在config.toml里添加如下配置即可.更多详见 https://utteranc.es

[params.utteranc]
    enable = true
    repo = ""    # 存储评论的Repo，格式为 owner/repo
    issueTerm = "pathname"  #表示你选择以那种方式让github issue的评论和你的文章关联。
    theme = "github-light" # 样式主题，有github-light和github-dark两种

对于以上issueTerm可以选择的配置有

  1. pathname 以路径的方式，推荐选项，这样你换域名的时候就不用担心评论找不到了
  2. url 全链接URL路径的方式。
  3. title 按页面title标题的方式。

其他还有几个不常用，这里就不再赘述了。

不蒜子页面计数器支持

该主题支持不蒜子这个极简的页面计数器支持，如果要启用不蒜子，可以在config.toml里添加如下配置即可.

[params]
  busuanzi = true

关于分类的名称转为小写的问题

Hugo 0.55 版本之前, 会有分类转成小写的问题，Hugo提供了preserveTaxonomyNames配置，把它设置为true就可以了保持原来分类的名字了。 在 Hugo 0.55 这个版本，hugo 移除了 preserveTaxonomyNames 配置， 模板已经默认获取 tag 和 categories 的原始字符用来展示, 大小写的问题已经优雅的解决了。

禁止URL路径小写

默认情况下，URL字符串里的字母都是小写的，这对于分类名、标签名是大写的来说，博客迁移后（比如从Hexo到Hugo），原来的链接就失效了， 为了解决这个问题，Hugo提供了disablePathToLower配置。

## 是否禁止URL Path转小写
disablePathToLower = true

生成带.html后缀的路径

如果配置参数 uglyurls = true，博客路径生成规则/年/月/日/Markdown文件的title或者filename加上.html结尾，注意路径都是小写。而且调试或发布 的时候都需要命令行加上参数 --uglyURLs

uglyurls = true
[frontmatter]
    date = [":filename", ":default"]
[permalinks]
    tech = "/:year/:month/:day/:filename"

注意新版hugo(0.78以后吧) --uglyURLs 不再支持，取代的做法就是设置系统的环境变量:

  • env HUGO_UGLYURLS="true" hugo server -D
  • env HUGO_UGLYURLS="true" hugo -D

但是全站每个md文件都会创建一个同名文件夹，然后其中放入index.html文件，并不好。可以单独在每份Front Matter中指定url，或者统一在 archetypes/default.md 中配置，url参数有多种实现方案，大家可以自由定义。下面是一份TOML格式示例：

+++
title = "{{ replace .Name "-" " " | title }}"
#url= {{ with replace .File.Dir "content" "" -}}{{- replace . "\\" "/" -}}{{- end -}}{{- .Name -}}.html
url = "{{ now.Format "/2006/01/" }}{{- .Name -}}.html"
date = "{{ .Date }}"
lastmod = "{{ .Date }}"
categories = []
tags = []
toc = false
draft = true
mysign = false
+++

可以单独在谋篇文章的Front Matter中指定 mysign = false, 就可以去掉本文下面的版权声明。

自定义CSS&JS

[params]
  # 这里我存放在了主题的static文件夹里，根目录的似乎也可以
  customCSS = ['douban.css', 'other.css']
  # if ['custom.css'], load '/static/css/custom.css' file
  customJS = ['douban.js']
  # if ['custom.js'], load '/static/js/custom.js' file

添加了部分自定义的shortcode

  • Octopress blockquote (blockquote.html)
  • Wikipedia Link Generator (wp.html)
{{< youku id="_XMzcxODQ2NjM2NA==" autoplay="true" >}}
  • youku（youku.html）

绘图支持

无太大必要，需要引入大量外部JS，同时绘制的效果并不太好，还是用专业的绘图工具比较好。因此我将相关代码屏蔽了。

贡献

欢迎大家贡献，不限于代码、issue，功能特性，想法等等，期待看到你的PR或者issue。

其他平台上的 Maupassant 主题

(THE END)

About

Maupassant theme, ported to Hugo. Forked from flysnow-org.

www.chende.ren

Resources

Readme

License

MIT license
Activity

Stars

2 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Languages

  • HTML 54.8%
  • CSS 44.8%
  • JavaScript 0.4%