该主题是Yue Yang的Dream主题的升级版本,并包含许多新功能,例如:
该主题可用于两个目的:
该项目遵守贡献者盟约行为准则。通过参加,您应该维护此代码。请向[email protected]报告不可接受的行为。
安装
入门
文档
快要完成了
贡献
执照
可以通过在Hugo网站文件夹中运行以下命令来安装该主题。
cd themes
git submodule add https://github.com/UtkarshVerma/hugo-dream-plus dream-plus
git submodule update --init --recursive一旦成功安装了主题,您就必须对主题进行一些调整才能满足您的口味。
在exampleSite文件夹中,您会发现配置文件, cards.toml和posts.toml ,可用于调整主题。
您必须将这些配置文件用作您的网站的基础,因为它们要照顾必要的变量声明,您可以根据需要进行编辑。
通过author表下方的params中的以下config变量来定义自己,如下所示:
[ params . author ]
author = " <name of the author> "
description = " Short description of the site "
motto = " author's motto or short description "
# Leaving the avatar variable unset displays svg avatars
avatar = " <absolute path to avatar> "之后,在配置文件末尾填写社交变量。此主题支持以下社交网站:(给出了示例)
| 社会联系 | 多变的 | 示例初始化 |
|---|---|---|
| github | github | github = "username" |
| 电子邮件 | 电子邮件 | email = "[email protected]" |
| 叽叽喳喳 | 叽叽喳喳 | twitter = "username" |
facebook = "username" | ||
| YouTube | YouTube | youtube = "username" |
| 中等的 | 中等的 | medium = "username" |
linkedin = "username" | ||
| stackoverflow | stackoverflow | stackoverflow = "number/username" |
| codepen | codepen | codepen = "username" |
reddit = "username" |
这些变量必须在[ config.toml的[social]表中,或与YAML或JSON等效物。
[ social ]
github = " UtkarshVerma "完成此操作后,按照此处的指示,在Markdown中写下您网站的“关于我”部分:错误和页面。
如前所述,此主题具有两个视图,卡视图和帖子视图。视图渲染的类型取决于您将内容的内容类型归为Dream Plus 。所以:
/content文件夹中具有cards文件夹会激活卡视图。/content夹中有posts文件夹会激活Post View 。
contentType变量现在已弃用。
两种视图之间的一个明确的区别是,卡视图不支持帖子,而是将其重定向到指定的链接,而后视图确实。您可以通过访问我的网站(上面说)来对其进行测试。同样,对于两种视图,邮政/卡创建都有不同的作用。如下:
hugo new cards/example.md # Card creation
hugo new posts/example.md # Post creation之后,只需打开您的降价卡/帖子,并提供卡/帖子的参数即可。
有两种不同的方法来配置此主题的背景。这些设置彼此相互排斥。
要设置特定的背景颜色,请通过color变量进行操作。如果要将颜色的随机组合设置为背景,只需将颜色变量放置不设置即可。
[ params . background ]
color = " #13547A " # Provide a color as hex or rgb equivalent 通过images数组指定要设置为背景的图像。如果您喜欢单个图像背景,则只需为数组提供一个值。例如:
[ params . background ]
images = [ " /images/bg1.jpeg " ] # Single image as background
images = [ " /images/bg1.jpeg " , " <some other image> " ] # Multiple images as background为images阵列提供多个图像启用Dream Plus的随机图像背景功能,该功能每次重新加载站点时都会在给定数组中循环背景。您也可以通过blur变量在一定程度上模糊背景。
所有背景配置变量都应放置在
params下的backround表中
[ params . background ]
# Random backgrounds
images = [ " /images/bg1.jpeg " , " /images/bg2.jpeg " , " /images/bg3.jpeg " ]
# Blur the background
blur = " 0.2 "每张明信片或卡的封面都是通过Dream Plus使用Hugo Image处理来处理更快的网站加载时间的。封面文件的查找路径如下所述:
/content/cards/<card>/cover.<any-extension>/content/posts/<post>/images/cover.<any-extension>
通过前磨牙指定封面图像现已弃用。现在,可以通过cover键通过前肌来定义卡盖。但是,图像处理不适用于此类封面。同样,前材料封面优先于图像资源,因此,为了使图像资源覆盖渲染,您必须首先从前材中删除封面键。
您也可以通过[params.features]中的coverArgs变量修改图像处理过程。通过的参数必须用于.Resize功能,因为那是梦想加上的用途。例如,
[ params . features ]
coverArgs = " 400x300 q50 " # Specify resolution and quality of output image您可以使用isMobile JS变量根据客户端设备配置网站。当客户端设备是移动设备时, true ,反之亦然。
此主题支持关于和错误页面的总自定义。这些页面可以通过about.md和404.md文件进行自定义。 Dream Plus将上述文件读取为普通的Markdown文本,然后将其呈现。完成文件并根据您的需求进行修改后,将它们粘贴到Hugo网站的content文件夹中。如果您不希望这些页面由Hugo构建,并提供了自己的链接,例如<website>.<domain>/about Or <website>.<domain>/404 。然后,您可以告诉Hugo通过config.toml文件中的ignoreFiles变量忽略它们,如下所示:
ignoreFiles = [ " content/404.md " , " content/about.md " ]您也可以通过params下的favicon Config变量为您的网站设置自定义Favicon。例如,
[params]
favicon = "/images/defaultFav.ico"
Short.st网站脚本已在此主题中实现。要使用它,您必须通过params下的shortest表进行配置。
[ params . shortest ]
enabled = true # Enable shorte.st
apiToken = " " # The API Token you received from shorte.st
domains = [ " " ] # The domains you want to define如果您想控制页面具有的帖子/卡的数量,则可以使用paginate Config变量进行操作。
paginate = 4 # Defaults to 10另外,启用标签不会默认情况下显示在标题和侧边栏上。在此处仅显示前8个标签(文章计数)以避免交通拥堵。但是,可以使用[params.tag]表的tagLimit变量覆盖它。
[ params . tag ]
enabled = true
tagLimit = 10 # Top 10 tags will be displayed
# or
tagLimit = 0 # Display all tags还有其他一些次要配置。您可以通过参考配置文件中的注释来设置它们。
该存储库的文档目前正在工作,并将其添加到该存储库的Wiki中。 Wiki贡献是最欢迎的。请随时向我询问此主题的功能。
完成配置后,您很高兴。因此,使用以下方式测试您的网站:
hugo server现在,您的网站应在本地可通过http:// localhost:1313用于测试目的。
要测试示例站点,您必须将配置文件明确指定为Hugo。如下所示:
# For posts view demo
hugo server --config posts.toml
# For cards view demo
hugo server --config cards.toml发现一些有趣的东西可以添加到此主题中,还是一个错误?通过问题跟踪器让我知道这一点。也欢迎拉动请求。有关如何贡献的更详细的说明,请参阅贡献。
该主题是根据麻省理工学院许可发布的。