mirror of
https://github.com/nunocoracao/blowfish.git
synced 2025-04-20 18:31:53 +02:00
translate configuration, content-examples, homepage-layout
This commit is contained in:
Weaxs
parent
1c800f6d1b
commit
d54ecd6a04
6 changed files with 757 additions and 4 deletions
344
exampleSite/content/docs/configuration/index.zh-cn.md
Normal file
344
exampleSite/content/docs/configuration/index.zh-cn.md
Normal file
|
|
@ -0,0 +1,344 @@
|
|||
---
|
||||
title: "配置"
|
||||
date: 2020-08-14
|
||||
draft: false
|
||||
description: "介绍 Blowfish 中所有可用的的配置变量。"
|
||||
slug: "configuration"
|
||||
tags: ["配置", "文档"]
|
||||
series: ["文档集"]
|
||||
series_order: 4
|
||||
---
|
||||
|
||||
Blowfish 适宜个高度定制化的主题，使用到了一些 Hugo 中最新的特性来简化配置方式。
|
||||
|
||||
主题附带了默认配置，可以让你快速启动一个基本的博客或静态网站。
|
||||
|
||||
{{< alert "fire" >}}
|
||||
我们刚刚推出了 CLI 工具，来帮助你快速上手 Blowfish。它将帮助你进行安装和配置。使用以下命令可以全局范围安装 CLI 工具：
|
||||
We just launched a CLI tool to help you get started with Blowfish. It will help you with installation and configuration. Install the CLI tool globally using:
|
||||
```bash
|
||||
npx blowfish-tools
|
||||
```
|
||||
{{< /alert >}}
|
||||
|
||||
> 配置文件是基于 TOML 格式的，这也是 Hugo 默认支持的语法。当然如果你愿意，也可以将配置转换成 YAML 或 JSON 格式。
|
||||
|
||||
默认情况下，在每个文件中都定义了主题中的可用参数，因此你可以自由调整设置来满足你的需求。
|
||||
|
||||
{{< alert >}}
|
||||
正如[安装说明]({{< ref "/docs/installation#set-up-theme-configuration-files" >}})中的内容，如果你想调整主题配置，可以修改 Hugo 项目中 `config/_default/` 文件夹下的文件，并删除项目根目录中的 `config.toml` 文件。
|
||||
{{< /alert >}}
|
||||
|
||||
## 网站配置
|
||||
|
||||
Blowfish 主题支持了 Hugo 框架中定义的所有标准配置变量。但如果希望有更好的体验，需要设置一些特定的配置。
|
||||
|
||||
网站配置是通过 `config/_default/config.toml` 文件管理的。下面的表格展示了 Blowfish 中的所有设置.
|
||||
|
||||
值得注意的是，表格中提供的变量名可以使用点表示法来简化 TOML 数据结构，例如 `outputs.home` 指的是 `[outputs] home`。
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
| 名称 | 默认值 | 描述 |
|
||||
|--------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `theme` | `"blowfish"` | 当你使用 Hugo 模块安装时，应该移除这个配置项。但对 Git 子模块或本地文件复制的安装方式，必须将其设置为 blowfish 才能正常工作。 |
|
||||
| `baseURL` | 无 | 网站 URL 根地址。 |
|
||||
| `defaultContentLanguage` | `"en"` | 这个值决定了主题中组件和内容所使用的默认语言。 参考 [语言和 i18n](#language-and-i18n) 部分来了解 blowfish 支持的所有语言代码。 |
|
||||
| `enableRobotsTXT` | `true` | 当开启这个值，`robots.txt` 文件将会被创建在站点根目录， 这将允许搜索引擎抓取整个网站。如果你想要自己提供 `robots.txt`，那么设置这个值为 `false` 并把你的文件放置到 `static` 目录下。 为了实现完全控制，你可以需要提供一个 [自定义布局]({{< ref "content-examples#custom-layouts" >}}) 来生成此文件。 |
|
||||
| `paginate` | `10` | 定义文章列表中，每页展示的文章数量。 |
|
||||
| `summaryLength` | `0` | 当[扉页参数]({{< ref "front-matter" >}}) 中没有提供文章摘要时，此参数定义了自动生成文章摘要的单词数量。如果值为`0`，则默认使用第一句话作为摘要。当摘要被隐藏，这个值没有任何效果。 |
|
||||
| `outputs.home` | `["HTML", "RSS", "JSON"]` | 为站点自动生成输出格式。Blowfish 要求 HTML、RSS 和 JSON 都需要有，以保证主题组件可以正常运作。 |
|
||||
| `permalinks` | 无 | 参考 [Hugo 文档](https://gohugo.io/content-management/urls/#permalinks) 中的自定义文章的固定链接配置。 |
|
||||
| `taxonomies` | 无 | 参考 [整理内容]({{< ref "getting-started#organising-content" >}}) 中的分类器配置。 |
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## 缩略图
|
||||
|
||||
Blowfish 的创立开端旨在便于为文章添加视觉效果。如果你熟悉 Hugo 的文章结构，只需要在你文章所在的文件夹中，放置一个以`feature*`开头的图像文件（Blowfish支持所有格式的文件，但更推荐使用 `.png` 或 `.jpg`）。就这样，Blowfish 就能够将图像文件作为文章的缩略图，而且能够在社交平台的 `<a target="_blank" href="https://oembed.com/">oEmbed</a>` 卡片中使用。
|
||||
|
||||
[这里]({{< ref "thumbnails" >}}) 可以看到更多内容，同时我们提供了一个[示例]({{< ref "thumbnail_sample" >}})，以便你具体看看如何操作。
|
||||
|
||||
## 语言和i18n
|
||||
|
||||
Blowfish 针对多语言网站进行了优化，主题的资源素材目前已经翻译成了多个语言版本。语言配置允许你生成多个版本的内容介绍，为网站的访问者提供他们母语的定制化体验。
|
||||
|
||||
Blowfish 主题目前默认支持了以下语言：
|
||||
|
||||
| 语言 | 代码 |
|
||||
|------------------------------|---------|
|
||||
| Arabic | `ar` |
|
||||
| Bulgarian | `bg` |
|
||||
| Bengali | `bn` |
|
||||
| Catalan | `ca` |
|
||||
| Czech | `cs` |
|
||||
| German | `de` |
|
||||
| English | `en` |
|
||||
| Spanish (Spain) | `es` |
|
||||
| Finnish | `fi` |
|
||||
| French | `fr` |
|
||||
| Hebrew | `he` |
|
||||
| Croatian | `hr` |
|
||||
| Hungarian | `hu` |
|
||||
| Indonesian | `id` |
|
||||
| Italian | `it` |
|
||||
| Japanese | `ja` |
|
||||
| Korean | `ko` |
|
||||
| Polish | `pl` |
|
||||
| Portuguese (Brazil) | `pt-br` |
|
||||
| Portuguese (Portugal) | `pt-pt` |
|
||||
| Romanian | `ro` |
|
||||
| Russian | `ru` |
|
||||
| Turkish | `tr` |
|
||||
| Vietnamese | `vi` |
|
||||
| Simplified Chinese (China) | `zh-cn` |
|
||||
| Traditional Chinese (Taiwan) | `zh-tw` |
|
||||
|
||||
|
||||
组件和静态资源的默认翻译在 `i18n/[code].yaml` 文件中，当然如果你想自定义，覆盖对应的文件即可。你也可以使用这种方法添加新的语言。如果你想与社区分享心得翻译，请[提交PR](https://github.com/nunocoracao/blowfish/pulls)。
|
||||
|
||||
### 配置
|
||||
|
||||
为了让 Blowfish 尽可能的灵活，每个网站都至少语言创建一个语言配置文件。默认情况下，Blowfish 提供了 `config/_default/languages.en.toml` 文件以默认支持英语。
|
||||
|
||||
默认的文件可以用来作为创建其他语言的一个模板，如果你希望用英语以外的语言撰写网站，也可以对其重命名。只需要格式遵循 `languages.[language-code].toml` 的命名即可。
|
||||
|
||||
{{< alert >}}
|
||||
**注意：** 保证 [网站设置](#site-configuration) 中的 `defaultContentLanguage`参数和你提供的语言配置文件相匹配。
|
||||
{{< /alert >}}
|
||||
|
||||
|
||||
#### 全局
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
| 名称 | 默认值 | 描述 |
|
||||
|----------------|--------------|-------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `languageCode` | `"en"` | Hugo 中的默认语言代码。他可以是一个高层级语言（例如 `en`），也可以是一个变体子语言（例如 `en-au`），但一定需要和语言配置文件中的语言代码相匹配。为了符合 HTML 的规范并设置设置大小写敏感的 `isoCode`，Hugo希望这个值最好是小写。 |
|
||||
| `languageName` | `"English"` | 语言名称。 |
|
||||
| `weight` | `1` | 权重决定了在构建多语言时的语言顺序。 |
|
||||
| `title` | `"Blowfish"` | 网站的标题。它将在网站头部和底部进行展示。 |
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
#### 参数
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
| 名称 | 默认值 | 描述 |
|
||||
|------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `params.displayName` | `"EN"` | 语言在网站中的展示名。 |
|
||||
| `params.isoCode` | `"en"` | 用于 HTML 元数据的 ISO 语言代码。他可以是一个高层级语言（例如 `en`），也可以是一个变体子语言（例如 `en-au`）。 |
|
||||
| `params.rtl` | `false` | 用于指定是否是 RTL 语言。设置为 `true` 则网站会从右向左重拍内容。Blowfish 完全支持同时使用 RTL 和 LTR 语言，并将动态调整。 |
|
||||
| `params.dateFormat` | `"2 January 2006"` | 用于指定如何日期格式化。参考 [Hugo 文档](https://gohugo.io/functions/format/#gos-layout-string) 了解可以支持的格式。 |
|
||||
| `params.logo` | 无 | `assets/` 文件夹中站点 logo 的相对路径。该 logo 文件需要提供 2x 分辨率并支持任何图像尺寸。 |
|
||||
| `params.secondaryLogo` | 无 | `assets/` 文件夹中站点次要 logo 的相对路径。该 logo 文件需要提供 2x 分辨率并支持任何图像尺寸。这个 logo 的颜色方案应该是和上面的是相反或对比的。如果设置了这个值，当用户从 `defaultAppearance` 模式切换时，将会显示这个 logo。 |
|
||||
| `params.description` | 无 | 网站表述。此参数将会被用作站点元数据。 |
|
||||
| `params.copyright` | 无 | 此参数是一个 Markdown，用于网站页脚的版权声明。此参数可以包含占位符 { year } ，以此动态插入当前年份。 如果没有提供，Blowfish 将会使用网站 `title` 自动生成版权信息。 |
|
||||
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
#### 作者
|
||||
| 名称 | 默认值 | 描述 |
|
||||
|-------------------|-----------|------------------------------------------------------------------------------------------------------|
|
||||
| `author.name` | 无 | 作者名。此参数将展示在文章页脚。并且如果主页使用了个人资料布局，也会展示此值。 |
|
||||
| `author.image` | 无 | 作者头像的文件路径。图像应该是 1:1 的宽高比。可以放在网站的 `assets/` 文件夹中，也可以是外部 URL。 |
|
||||
| `author.headline` | 无 | 包含作者头衔的 Markdown。它将展示在主页中作者姓名打分下方。 |
|
||||
| `author.bio` | 无 | 包含作者简介的 Markdown。它将展示在文章页脚。 |
|
||||
| `author.links` | 无 | 与作者详细信息一起显示的链接。配置文件中包含示例链接，取消注释即可启用。链接展示的顺序由他们在数组中定义的顺序决定。如果你想自定义链接，可以在 `assets/icons/` 中提供相应的SVG图片。 |
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
### 菜单
|
||||
|
||||
Blowfish 还支持针对特定语言的菜单配置。菜单配置文件的命名规则和语言配置文件的格式类似。只需要在文件名中提供语言代码，Hugo 就可以知道这是针对哪种语言的菜单。
|
||||
|
||||
菜单配置文件的命名格式是 `menus.[language-code].toml`。请始终确保菜单配置项中使用的语言代码和语言配置相匹配。
|
||||
|
||||
[快速开始]({{< ref "getting-started#menus" >}})部分更详细地介绍了这个文件的结构。你还可以参考 [Hugo 菜单文档](https://gohugo.io/content-management/menus/)，以获取更多配置示例。
|
||||
|
||||
## 主题参数
|
||||
|
||||
Blowfish 提供了大量控制主题功能的配置参数，下面的表格中列举了 `config/_default/params.toml` 文件中所有的可用参数。
|
||||
|
||||
下面列举的文章参数是全局默认值，都可以在每个文章中的前置元数据内容中进行覆盖。详细可以参考 [扉页参数]({{< ref "front-matter" >}})。
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
|
||||
### 全局
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
|---------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `colorScheme` | `"blowfish"` | 主题使用的颜色方案。合法的值有： `blowfish` （默认）、`avocado`、`fire`、`ocean`、`forest`、`princess`、`neon`、`bloody`、`terminal`、`marvel`、`noir`、`autumn`、`congo` 和 `slate`。 具体参考[颜色方案]({{< ref "getting-started#colour-schemes" >}})以获取更多信息。 |
|
||||
| `defaultAppearance` | `"light"` | 默认的主题外观，可以是 `light` 或者 `dark`。 |
|
||||
| `autoSwitchAppearance` | `true` | 主题外观是否根据访问者操作系统的偏好自动切换。设置为 `false` 会强制网站始终使用 `defaultAppearance`。 |
|
||||
| `enableSearch` | `false` | 是否开启网站的搜索功能，设为 `true` 即为启用。注意，搜索功能依赖于[站点设置](#site-configuration)中的 `outputs.home` 设置，请确保此值配置正确。 |
|
||||
| `enableCodeCopy` | `false` | 是否可以将`<code>`代码块复制到剪贴板。想要使用代码复制功能，需要将 `highlight.noClasses` 参数设置为 `false`。 阅读 [其他配置文件](#other-configuration-files) 以获取更多信息。 |
|
||||
| `mainSections` | 无 | 指定最近文章中应该展示的模块。 如果没有指定，则使用文章数量最多的板块。 |
|
||||
| `showViews` | 无 | 是否显示文章和列表页面的阅读量。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `showLikes` | 无 | 是否显示文章和列表页面的喜爱数。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `robots` | 无 | 用于支持搜索引擎爬虫如何处理你的网站。如果设置了该值，它将被输出在页面头部。具体的参数值请参考 [Google 文档](https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives)。 |
|
||||
| `disableImageZoom` | `false` | 禁用网站上所有图片缩放功能。 |
|
||||
| `disableImageOptimization` | `false` | 禁用图片上所有图片的调整大小和优化功能。 |
|
||||
| `disableTextInHeader` | `false` | 禁用文本类型的标题，对基于 logo 的标题很有用。 |
|
||||
| `defaultBackgroundImage` | 无 | 设置默认背景图，用于 `background` 和 `hero` 布局下的主页。 |
|
||||
| `defaultFeaturedImage` | 无 | 设置默认背景图片，用于所有文章的`featured`图片，可以通过文章目录中的 `featured` 图片替换。 |
|
||||
| `highlightCurrentMenuArea` | 无 | 当菜单被选择时，标记主菜单中的菜单项。 |
|
||||
| `smartTOC` | 无 | 开启智能目录，视图中的项目将会被高亮显示。 |
|
||||
| `smartTOCHideUnfocusedChildren` | 无 | 当开启智能目录，如果目录级别不再被聚焦时，将会隐藏更深层次的目录。 |
|
||||
|
||||
### 页头
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| --------------- | --------- |----------------------------------------------------------------------------|
|
||||
| `header.layout` | `"basic"` | 定义整个站点的页头的布局，支持的参数有 `basic`、`fixed`、`fixed-fill`、and `fixed-fill-blur`. |
|
||||
|
||||
### 页脚
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ------------------------------- | ------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `footer.showMenu` | `true` | 显示/隐藏页面底部菜单，该菜单可以在 `config/_default/menus.en.toml` 文件中的 `[[footer]]` 部分进行配置。 |
|
||||
| `footer.showCopyright` | `true` | 是否在底部显示 copyright 版权信息。请注意，如果你想定制，可以在[语言配置](#language-and-i18n)中使用 `copyright` 参数。 |
|
||||
| `footer.showThemeAttribution` | `true` | 是否在网站底部中显示"powered by" 的主题归属信息。如果禁用此参数，请考虑在你网站的其他位置设置主题归属信息，例如在关于页面。 |
|
||||
| `footer.showAppearanceSwitcher` | `false` | 是否在也页面底部显示外观切换器。浏览器的本地存储会缓存访问者的偏好设置。 |
|
||||
| `footer.showScrollToTop` | `true` | 当设置为 `true` 时，显示返回顶部的箭头按钮。 |
|
||||
|
||||
### 主页
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ------------------------------- | ----------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `homepage.layout` | `"profile"` | 首页布局参数。合法的参数值有： `page`、`profile`、`hero`、`card`、`background` 或 `custom`。当你设置为 `custom` 时，你必须创建 `/layouts/partials/home/custom.html` 文件以定制自己的布局。参考[主页布局]({{< ref "homepage-layout" >}})来获取更多信息。 |
|
||||
| `homepage.homepageImage` | 无 | 在 `hero` 和 `card` 布局中使用的图像。图片可以来自于本地的资源目录，也可以是外部图像 URL。参考 [主页布局]({{< ref "homepage-layout" >}}) 来获取更多信息。 |
|
||||
| `homepage.showRecent` | `false` | 是否在主页展示最新文章列表。 |
|
||||
| `homepage.showRecentItems` | 5 | 如果将 `showRecent` 设置为 `true`，此参数用于显示多少篇文章。如果没有设置或者为0，则默认显示5篇文章。 |
|
||||
| `homepage.showMoreLink` | `false` | 是否在主页底部添加“显示更多”，该链接会降会用带到一个预定义位置。 |
|
||||
| `homepage.showMoreLinkDest` | `/posts` | 更多按钮所指向的位置。 |
|
||||
| `homepage.cardView` | `false` | 将列表展示为卡片容器。 |
|
||||
| `homepage.cardViewScreenWidth` | `false` | 增强列表中卡片的宽度，使其可以占据可用的全部宽度。 |
|
||||
| `homepage.layoutBackgroundBlur` | `false` | 向下滚动主页时，是否模糊背景图。 |
|
||||
|
||||
### 文章页
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ------------------------------------- | --------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `article.showDate` | `true` | 是否显示日期。 |
|
||||
| `article.showViews` | `false` | 是否显示文章阅读量。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `article.showLikes` | `false` | 是否显示文章喜爱数。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `article.showDateOnlyInArticle` | `false` | 是否在文章内显示日期，不影响文章列表或卡片页面的日期显示。 |
|
||||
| `article.showDateUpdated` | `false` | 是否展示文章的更新日期。 |
|
||||
| `article.showAuthor` | `true` | 是否在文章底部显示作者框。 |
|
||||
| `article.showHero` | `false` | 缩略图是否会在每个页面中作为 hero 图像显示。 |
|
||||
| `article.heroStyle` | 无 | hero 图像的展示样式，可选的参数值有：`basic`、`big`、`background`、`thumbAndBackground`。 |
|
||||
| `article.layoutBackgroundBlur` | `true` | 向下滚动文章页时，是否模糊背景图。 |
|
||||
| `article.layoutBackgroundHeaderSpace` | `true` | 在标题和正文之间添加空白区域间隔。 |
|
||||
| `article.showBreadcrumbs` | `false` | 是否在标题栏显示面包屑导航。 |
|
||||
| `article.showDraftLabel` | `true` | 当使用 `--buildDrafts` 构建网站时，是否在文章旁边显示草稿。 |
|
||||
| `article.showEdit` | `false` | 是否展示编辑文章的链接。 |
|
||||
| `article.editURL` | 无 | 当激活 `article.showEdit` 参数，此参数用于设置文章的编辑链接。 |
|
||||
| `article.editAppendPath` | `true` | 当激活 `article.showEdit` 参数，是否将文章的路径附加到 `article.editURL` 参数所设置的 URL 后面。 |
|
||||
| `article.seriesOpened` | `false` | 是否默认显示打开系列模块、 |
|
||||
| `article.showHeadingAnchors` | `true` | 是否在文章标题旁添加锚点。 |
|
||||
| `article.showPagination` | `true` | 是否在文章末尾展示上一篇/下一篇的文章链接。 |
|
||||
| `article.invertPagination` | `false` | 是否翻转下一篇/上一篇文章链接的方向。 |
|
||||
| `article.showReadingTime` | `true` | 是否展示文章的阅读时间。如果你的语言包含 CJK 语言，需要在 `config.toml` 中开启 `hasCJKLanguage` 参数。 |
|
||||
| `article.showTableOfContents` | `false` | 是否展示文章的目录。 |
|
||||
| `article.showRelatedContent` | `false` | 为文章显示相关内容。如果你想要启用此功能，请检查 `config.toml` 文件并复制所有 *related* 相关的参数，如果你想自定义，也可以对 `config.toml` 添加额外配置。更多内容请参考 [Hugo 文档](https://gohugo.io/content-management/related/) 中关于 *related* 的内容。 |
|
||||
| `article.relatedContentLimit` | `3` | 如果启用`showRelatedContent`，则限制显示相关文章的数量。 |
|
||||
| `article.showTaxonomies` | `false` | 是否显示文章的分类或标签信息。 |
|
||||
| `article.showAuthorsBadges` | `false` | 是否在文章或列表中显示 `authors` 分类。这需要开启多个作者 `multiple authors` 和 `authors` 分类法。 请阅读 [这个网页]({{< ref "multi-author" >}}) 来获取更多内容。 |
|
||||
| `article.showWordCount` | `false` | 是否显示文章的字数。 如果你的语言包含 CJK 语言，需要在 `config.toml` 中开启 `hasCJKLanguage` 参数。 |
|
||||
| `article.showComments` | `false` | 是否在文章末尾添加 [评论部分]({{< ref "partials#comments" >}})。 |
|
||||
| `article.sharingLinks` | 无 | 在文章末尾显示的分享链接。如果没有提供或设置为 `false`，则不会显示任何分享链接。可用的值包括："linkedin"、"twitter"、"reddit"、"pinterest"、"facebook"、"email"、"whatsapp" 和 "telegram" |
|
||||
| `article.showZenMode` | `false` | 指定是否激活文章阅读的禅模式，即隐藏常规的界面元素。 |
|
||||
|
||||
### 列表页
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ---------------------------------- | --------- |--------------------------------------------------------------------------------------------------------------------------|
|
||||
| `list.showHero` | `false` | 缩略图是否会在每个页面中作为 hero 图像显示。 |
|
||||
| `list.heroStyle` | 无 | hero 图像的展示样式，可选的参数值有：`basic`、`big`、`background`、`thumbAndBackground`。 |
|
||||
| `list.showBreadcrumbs` | `false` | 是否在标题栏显示面包屑导航。 |
|
||||
| `list.layoutBackgroundBlur` | `true` | 向下滚动列表页时，是否模糊背景图。 |
|
||||
| `list.layoutBackgroundHeaderSpace` | `true` | 在标题和正文之间添加空白区域间隔。 |
|
||||
| `list.showTableOfContents` | `false` | 是否展示目录。 |
|
||||
| `list.showSummary` | `false` | 是否在列表页显示文章摘要。如果在[扉页参数]({{< ref "front-matter" >}})中没有提供摘要，那么将会使用[站点配置](#site-configuration) 中的 `summaryLength` 参数自动生成一个。 |
|
||||
| `list.showViews` | `false` | 是否显示文章阅读量。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `list.showLikes` | `false` | 是否显示文章喜爱数。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `list.showCards` | `false` | 是否将每个文章显示未卡片或简单的内联文本。 |
|
||||
| `list.groupByYear` | `true` | 是否根据年做聚合。 |
|
||||
| `list.cardView` | `false` | 将列表展示为卡片容器。 |
|
||||
| `list.cardViewScreenWidth` | `false` | 增强列表中卡片的宽度，使其可以占据可用的全部宽度。 |
|
||||
| `list.constrainItemsWidth` | `false` | 将项目宽度限制为 `prose` 以提高可读性。在没有 featurn 图片的时候非常有用。 |
|
||||
| `list.showTableOfContents` | `false` | 是否显示目录。 |
|
||||
|
||||
### Sitemap
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ----------------------- | ---------------------- |-------------------------------------------------------------------------------------------------------------|
|
||||
| `sitemap.excludedKinds` | `["taxonomy", "term"]` | 从生成的 `/sitemap.xml` 文件中排除的内容。 具体的配置请参考[Hugo 文档](https://gohugo.io/templates/section-templates/#page-kinds)。 |
|
||||
|
||||
### 分类法
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ------------------------------ | --------- |-----------------------------------------------------------------------|
|
||||
| `taxonomy.showTermCount` | `true` | 是否在分类列表总显示对应的数量。 |
|
||||
| `taxonomy.showHero` | `false` | 缩略图是否会在每个页面中作为 hero 图像显示。 |
|
||||
| `taxonomy.heroStyle` | 无 | hero 图像的展示样式，可选的参数值有：`basic`、`big`、`background`、`thumbAndBackground`。 |
|
||||
| `taxonomy.showBreadcrumbs` | `false` | 是否在标题栏显示面包屑导航。 |
|
||||
| `taxonomy.showViews` | `false` | 是否显示文章阅读量。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `taxonomy.showLikes` | `false` | 是否显示文章喜爱数。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `taxonomy.showTableOfContents` | `false` | 是否显示目录。 |
|
||||
| `taxonomy.cardView` | `false` | 将列表展示为卡片容器。 |
|
||||
|
||||
### 术语
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| -------------------------- | --------- |----------------------------------------------------------------------|
|
||||
| `term.showHero` | `false` | 缩略图是否会在每个页面中作为 hero 图像显示。 |
|
||||
| `term.heroStyle` | 无 | hero 图像的展示样式，可选的参数值有： `basic`、`big`、`background`、`thumbAndBackground`。 |
|
||||
| `term.showBreadcrumbs` | `false` | 是否在标题栏显示面包屑导航。 |
|
||||
| `term.showViews` | `false` | 是否显示文章阅读量。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `term.showLikes` | `false` | 是否显示文章喜爱数。这需要集成 firebase ，具体可以看下面。 |
|
||||
| `term.showTableOfContents` | `false` | 是否显示目录。 |
|
||||
| `term.groupByYear` | `false` | 是否根据年做聚合。 |
|
||||
| `term.cardView` | `false` | 将列表展示为卡片容器。 |
|
||||
| `term.cardViewScreenWidth` | `false` | 增强列表中卡片的宽度，使其可以占据可用的全部宽度。 |
|
||||
|
||||
### Firebase
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ---------------------------- | --------- |---------------------------------------------------------------------------------------------------------------------|
|
||||
| `firebase.apiKey` | 无 | Firebase apiKey， 与 Firebase 集成的必填参数。了解如何将 Firebase 集成进 Blowfish 请参考 [这个页面]({{< ref "firebase-views" >}})。 |
|
||||
| `firebase.authDomain` | 无 | Firebase authDomain，与 Firebase 集成的必填参数。了解如何将 Firebase 集成进 Blowfish 请参考 [这个页面]({{< ref "firebase-views" >}})。 |
|
||||
| `firebase.projectId` | 无 | Firebase projectId，与 Firebase 集成的必填参数。了解如何将 Firebase 集成进 Blowfish 请参考 [这个页面]({{< ref "firebase-views" >}})。 |
|
||||
| `firebase.storageBucket` | 无 | Firebase storageBucket，与 Firebase 集成的必填参数。了解如何将 Firebase 集成进 Blowfish 请参考 [这个页面]({{< ref "firebase-views" >}})。 |
|
||||
| `firebase.messagingSenderId` | 无 | Firebase messagingSenderId，与 Firebase 集成的必填参数。了解如何将 Firebase 集成进 Blowfish 请参考 [这个页面]({{< ref "firebase-views" >}})。 |
|
||||
| `firebase.appId` | 无 | Firebase appId，与 Firebase 集成的必填参数。了解如何将 Firebase 集成进 Blowfish 请参考 [这个页面]({{< ref "firebase-views" >}})。 |
|
||||
| `firebase.measurementId` | 无 | Firebase measurementId，与 Firebase 集成的必填参数。了解如何将 Firebase 集成进 Blowfish 请参考 [这个页面]({{< ref "firebase-views" >}})。 |
|
||||
|
||||
### Fathom Analytics
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ------------------------ | --------- |----------------------------------------------------------------------|
|
||||
| `fathomAnalytics.site` | 无 | 支持 Fathom 站点分析平台。更多详细内容请参考 [分析文档]({{< ref "partials#analytics" >}})。 |
|
||||
| `fathomAnalytics.domain` | 无 | 如果使用自定义域名的 Fathom Analytics，请在此提供，以便从自定义域名获取 `script.js`】。 |
|
||||
|
||||
### BuyMeACoffee
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
| ----------------------------------- | --------- |---------------------------|
|
||||
| `buymeacoffee.identifier` | 无 | buymeacoffee 账号的用户名。 |
|
||||
| `buymeacoffee.globalWidget` | 无 | 激活位于全局的 buymeacoffee 组件。 |
|
||||
| `buymeacoffee.globalWidgetMessage` | 无 | 新用户首次访问网站时显示的消息。 |
|
||||
| `buymeacoffee.globalWidgetColor` | 无 | 组件颜色，使用 HEX 格式。 |
|
||||
| `buymeacoffee.globalWidgetPosition` | 无 | 组件位置，例如 "Left" 或 "Right"。 |
|
||||
### 验证
|
||||
|
||||
| 名称 | 默认值 | 描述 |
|
||||
|--------------------------| --------- |----------------------------------------------------------------------------------------|
|
||||
| `verification.google` | 无 | Google 提供的网站验证字符串，用于在网站元数据中包含。 |
|
||||
| `verification.bing` | 无 | Bing 提供的网站验证字符串，用于在网站元数据中包含。 |
|
||||
| `verification.pinterest` | 无 | Pinterest 提供的网站验证字符串，用于在网站元数据中包含。 |
|
||||
| `verification.yandex` | 无 | Yandex 提供的网站验证字符串，用于在网站元数据中包含。 |
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## 别的配置文件
|
||||
|
||||
Blowfish 主题还包括 `markup.toml` 配置文件。这个文件包含了一些重要参数，来确保 Hugo 正确配置以生成使用 Blowfish 创建的网站。
|
||||
|
||||
需要确保次文件在 `config` 目录中，并设置所需要的值。否则某些功能可能无法正确启用，并可能导致意外行为。
|
||||
318
exampleSite/content/docs/content-examples/index.zh-cn.md
Normal file
318
exampleSite/content/docs/content-examples/index.zh-cn.md
Normal file
|
|
@ -0,0 +1,318 @@
|
|||
---
|
||||
title: "内容示例"
|
||||
date: 2020-08-09
|
||||
draft: false
|
||||
description: "包含 Blowfish 中所有可用部分的示例、"
|
||||
slug: "content-examples"
|
||||
tags: ["内容", "示例"]
|
||||
series: ["文档集"]
|
||||
series_order: 12
|
||||
---
|
||||
|
||||
如果你已经按顺序阅读了文档，那么你现在应该已经了解了 Blowfish 中所有的功能和配置信息。这个页面旨在把所有内容整合在一起，并提供一些你会在 Hugo 项目中使用的示例。
|
||||
|
||||
{{< alert >}}
|
||||
**提示:** 如果你是Hugo的新用户，请务必阅读[官方文档](https://gohugo.io/content-management/page-bundles/)，了解更多关于页面捆绑和资源的概念。
|
||||
{{< /alert >}}
|
||||
|
||||
这个页面上的示例都可以根据不同的场景进行调整，期待你在做自己项目的同时，提出一些对特定内容格式化的想法。
|
||||
|
||||
## 分支页面
|
||||
|
||||
Hugo 中的分支页面包括主页、部分列表页面和分类页面等内容，请记住，这些分支页面的文件名都是 **`_index.md`**。
|
||||
|
||||
Blowfish 支持在分支页面中设置[扉页参数]({{< ref "front-matter" >}})，在扉页中设置的参数将会覆盖在配置文件中设置的参数默认值。例如，在分支页面中的 `title` 参数将会覆盖页面标题的默认值。
|
||||
|
||||
### 主页
|
||||
|
||||
| | |
|
||||
| ------------ | -------------------- |
|
||||
| **Layout:** | `layouts/index.html` |
|
||||
| **Content:** | `content/_index.md` |
|
||||
|
||||
Blowfish 中的主页比较特殊，它的整体设计是由主页的布局参数控制的。你可以在 [主页布局]({{< ref "homepage-layout" >}}) 来获取更多内容。
|
||||
|
||||
如果你想自定义主页的内容，你仅需创建一个 `content/_index.md` 文件。该文件中的任何内容都会包含在你的主页中。
|
||||
|
||||
**示例：**
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "欢迎来到 Blowfish ！"
|
||||
description: "这是往主页中添加内容的例子。"
|
||||
---
|
||||
欢迎来到我的网站！我很高兴你的来访。
|
||||
```
|
||||
_这个例子设置了一个自定义标题，并在页面正文中添加了一些额外的内容。当然任何的 Markdown 都是可接受的，包括短代码、图片和连接。_
|
||||
|
||||
### 列表页
|
||||
|
||||
| | |
|
||||
| ------------ | ---------------------------- |
|
||||
| **Layout:** | `layouts/_default/list.html` |
|
||||
| **Content:** | `content/../_index.md` |
|
||||
|
||||
列表页将所有页面聚合到一个目录下，并为访问者提供了一种浏览页面的方式。博客或者作品集是一个典型案例，因为这两种类型的网站会将帖子或项目整合到一个列表页中。
|
||||
|
||||
创建一个列表页就如同创建子目录一样简单。例如，要创建一个 "Projects" 列表页，你可以创建`content/projects/`。然后为你的项目创建一个 Markdown 文件。
|
||||
Creating a list page is as simple as making a sub-directory in the content folder. For example, to create a "Projects" section, you would create `content/projects/`. Then create a Markdown file for each of your projects.
|
||||
|
||||
列表页面默认会自动生成，如果你想在列表添加一些页自定义内容，还需要在此目录创建一个 `_index.md` 文件。
|
||||
|
||||
```shell
|
||||
.
|
||||
└── content
|
||||
└── projects
|
||||
├── _index.md # /projects
|
||||
├── first-project.md # /projects/first-project
|
||||
└── another-project
|
||||
├── index.md # /projects/another-project
|
||||
└── project.jpg
|
||||
```
|
||||
|
||||
Hugo 将会自动为目录中对应的项目页面生成 URL。
|
||||
|
||||
类似于主页，列表页面也可以通过 `_index.md` 文件来添加自定义的内容。Blowfish将会在自定义内容的下方，展示这个列表所包含的所有子页面。
|
||||
|
||||
**示例：**
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "项目"
|
||||
description: "了解我的一些项目。"
|
||||
cascade:
|
||||
showReadingTime: false
|
||||
---
|
||||
本节包含了我所有的当前项目。
|
||||
```
|
||||
|
||||
_在上面的示例中，这里的 `cascade` 参数被用来隐藏该列表页下任何子页面的阅读时间。这样做是的任何子页面都不会显示阅读时间，这是一种为整个部分添加默认参数的好方法。_
|
||||
|
||||
[样本部分]({{< ref "samples" >}})提供了列表页面的例子。
|
||||
|
||||
### 分类页面
|
||||
|
||||
| | |
|
||||
| ---------------- | -------------------------------- |
|
||||
| **List layout:** | `layouts/_default/taxonomy.html` |
|
||||
| **Term layout:** | `layouts/_default/term.html` |
|
||||
| **Content:** | `content/../_index.md` |
|
||||
|
||||
分类页面有两种形式：分类列表和分类术语。列表页面显示给定分类中每个属于的列表，术语页面显示与给定术语相关的页面列表。
|
||||
|
||||
术语这个词可能会有些令人困惑，所以这里让我们举个例子，假设将 `animals` 分类。
|
||||
|
||||
首先，想要在 Hugo 中使用分类，需要先进行配置。通过创建 `config/_default/taxonomies.toml` 文件并定义分类名称来完成创建。
|
||||
|
||||
```toml
|
||||
# config/_default/taxonomies.toml
|
||||
|
||||
animal = "animals"
|
||||
```
|
||||
|
||||
Hugo 期望分类定义式 单数 = “复数” 的形式，所以这里添加单数 `animal` 等于复数 `animals` 来创建我们的分类示例。
|
||||
|
||||
现在 `animals` 分类就有了，需要在内容中添加它。下面是一个简单的在扉页参数中添加分类的例子：
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "进入狮子的巢穴"
|
||||
description: "这周我们学习狮子。"
|
||||
animals: ["lion", "cat"]
|
||||
---
|
||||
```
|
||||
|
||||
现在我们已经在 `animals` 分类中添加了 `lion` 和 `cat` 两个术语。
|
||||
|
||||
目前看起来还不太明显，但是 Hugo 将会为这个分类自动生成分类列表页和两个术语页。默认情况下可以在 `/animals/` 地址访问列表页，在 `/animals/lion/` 和 `/animals/cat/` 访问术语页。
|
||||
|
||||
这个列表页会列举出所有包含在这个分类中的术语。在上面的例子中，`/animals/` 页面会包含 "lion" 和 "cat" 的链接，以此将访问者导向至具体的术语页。
|
||||
|
||||
术语页将会列举出包含这个术语的所有页面。这些术语页面本质上和[列表页面](#list-pages)相同，并且以类似的方式运作。
|
||||
|
||||
如果你想在分类页面中添加自定义的内容，只需要对应文件夹的目录中创建 `_index.md` 文件即可。
|
||||
|
||||
```shell
|
||||
.
|
||||
└── content
|
||||
└── animals
|
||||
├── _index.md # /animals
|
||||
└── lion
|
||||
└── _index.md # /animals/lion
|
||||
```
|
||||
|
||||
这些 `_index.md` 中的内容都会放置在生成的分类页面上。与其他页面一样，[扉页参数]({{< ref "front-matter" >}})中设置的变量也可以用来覆盖默认值。比如你可以有一个标签名是`lion`，但是可以将其覆盖成 "Lion"。
|
||||
|
||||
想要查看实际效果，可以看[标签分类列表]({{< ref "tags" >}})。
|
||||
|
||||
## 叶子页面
|
||||
|
||||
| | |
|
||||
| ------------------------- | ------------------------------- |
|
||||
| **Layout:** | `layouts/_default/single.html` |
|
||||
| **Content (standalone):** | `content/../page-name.md` |
|
||||
| **Content (bundled):** | `content/../page-name/index.md` |
|
||||
|
||||
Hugo 中的页面叶子页面是一个标准的内容页面，它不包含子页面的页面。可以作为关于页面，或者位于个人博客网站中的文章。
|
||||
|
||||
最重要的是，与分支页面不同，叶子页面应该被命名为 `index.md`，而不是带下划线的`_index.md`。叶子页面比较特殊，它可以是一个在列表页面中的一个有唯一名称的文件，也可以是在一个有唯一名称的页面捆绑包。
|
||||
|
||||
```shell
|
||||
.
|
||||
└── content
|
||||
└── blog
|
||||
├── first-post.md # /blog/first-post
|
||||
├── second-post.md # /blog/second-post
|
||||
└── third-post
|
||||
├── index.md # /blog/third-post
|
||||
└── image.jpg
|
||||
```
|
||||
|
||||
当页面中包含类似图片的资源，应该使用页面捆绑包，即子目录的方式。页面捆绑包时一个包含 `index.md` 文件的子目录。将资源和页面内容打包在同一个目录中是必要的，因为许多短代码和其他主题逻辑假设资源和页面捆绑在一起，
|
||||
|
||||
**示例：**
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "我的第一篇博客文章"
|
||||
date: 2022-01-25
|
||||
description: "欢迎来到我的博客"
|
||||
summary: "了解更多关于我和我创建博客的初衷。"
|
||||
tags: ["welcome", "new", "about", "first"]
|
||||
---
|
||||
_这_ 是博客的内容。
|
||||
```
|
||||
|
||||
叶子页面有很多的[扉页参数]({{< ref "front-matter" >}})，来帮你你自定义展示它。
|
||||
|
||||
### 外部链接
|
||||
|
||||
Blowfish 允许外部页面链接和文章列表一起显示在列表页。如果你在第三方网站（如Medium）有文章，或者你想连接到研究论文，而不想在 Hugo 中复制内容，这将非常有用。
|
||||
|
||||
为了创建一个外部链接文章，需要设置一些特殊的扉页参数：
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "我的 Medium 文章"
|
||||
date: 2022-01-25
|
||||
externalUrl: "https://medium.com/"
|
||||
summary: "我在Medium上写了一篇文章。"
|
||||
showReadingTime: false
|
||||
_build:
|
||||
render: "false"
|
||||
list: "local"
|
||||
---
|
||||
```
|
||||
|
||||
除了像 `title` 和 `summary` 这种普通的扉页参数外，需要设置 `externalUrl` 参数来告诉 Blowfish 这不是一篇普通的文章。访问者在访问后，会被重定向到这里提供的 URL。
|
||||
|
||||
此外，我们使用了 `_build` 参数来避免 Hugo 生成一个普通页面。因为我们是一个连接到外部的 URL，生成页面是没有意义的。
|
||||
|
||||
Hugo 中可以通过命令来快速生成一个外部链接的文件，在创建新的外部链接是，只需要指定 `-k external` 即可。这让生成外部链接文章变得更简单。
|
||||
|
||||
```shell
|
||||
hugo new -k external posts/my-post.md
|
||||
```
|
||||
|
||||
### 简单页面
|
||||
|
||||
| | |
|
||||
| ----------------- | ------------------------------ |
|
||||
| **Layout:** | `layouts/_default/simple.html` |
|
||||
| **Front Matter:** | `layout: "simple"` |
|
||||
|
||||
Blowfish 包含了一个用于简单页面的布局。简单布局是一个全宽的模板，并仅仅展示 Markdown 中的内容，不包含任何主题中的特性。
|
||||
|
||||
简单布局中唯一可用的特性是面包屑导航和分享链接。这个行为也是通过 [扉页参数]({{< ref "front-matter" >}}) 来控制。
|
||||
|
||||
如果想在特定页面上启用简单布局，添加 `layout` 扉页参数，并设置为 `"simple"`：
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "我的着陆页"
|
||||
date: 2022-03-08
|
||||
layout: "simple"
|
||||
---
|
||||
这个页面的内容是全宽的。
|
||||
```
|
||||
|
||||
## 自定义布局
|
||||
|
||||
Hugo 的其中一个好处就是它让整个站点、单独内容或页面创建自定义布局变得容易。
|
||||
|
||||
自定义布局遵循所有 Hugo 的模板规则，更多信息可以在 [Hugo 官方文档](https://gohugo.io/templates/introduction/) 中找到。
|
||||
|
||||
### 覆盖默认布局
|
||||
|
||||
上面讨论的每种内容类型都列出了其对应的布局文件。如果你在本地项目中创建了这个文件，它将覆盖主题的默认模板，由此可以来自定义网站的样式布局。
|
||||
|
||||
例如，创建一个 `layouts/_default/single.html` 文件，此文件将允许用户完全自定义叶子页面的布局。
|
||||
|
||||
### 自定义部分布局
|
||||
|
||||
如果你想为个别内容创建自定义布局也很简单。这在使用特定样式列出某种类型内容时会非常有效。
|
||||
|
||||
让我们简单看一个例子，来了解如何为"Projects"页面创建自定义的特殊布局。
|
||||
|
||||
为了做到这一点，使用常规的Hugo规则来在 `content` 目录下组织你的内容。此外，在和 `layout` 目录中创建和内容部分相同的目录结构，并在此目录下添加一个 `list.html` 文件，此文件是 "projects" 内容的一个新的列表页布局。
|
||||
|
||||
```shell
|
||||
.
|
||||
└── content
|
||||
│ └── projects
|
||||
│ ├── _index.md
|
||||
│ ├── first-project.md
|
||||
│ └── second-project.md
|
||||
└── layouts
|
||||
└── projects
|
||||
└── list.html
|
||||
```
|
||||
|
||||
`list.html` 文件将会覆盖默认的模板，但只会作用在 `projects` 部分。我们先看看 `_index.md` 文件的内容。
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: "Blowfish"
|
||||
date: 2021-08-11
|
||||
icon: "github"
|
||||
description: "用Tailwind CSS构建的Hugo主题。"
|
||||
topics: ["Hugo", "Web", "Tailwind"]
|
||||
externalUrl: "https://github.com/nunocoracao/blowfish/"
|
||||
---
|
||||
```
|
||||
|
||||
_在这个例子中，我们为每个项目添加了一些参数，然后我们在列表模板中可以使用他们。虽然这个例子没有页面的内容，但这并不组织你添加内容。这是自己的的自定义模板，完全可以随心所欲！_
|
||||
|
||||
定义了项目内容后，现在我们可以创建一个列表模板来输出项目中的信息。
|
||||
```go
|
||||
{{ define "main" }}
|
||||
<section class="mt-8">
|
||||
{{ range .Pages }}
|
||||
<article class="pb-6">
|
||||
<a class="flex" href="{{ .Params.externalUrl }}">
|
||||
<div class="mr-3 text-3xl text-neutral-300">
|
||||
<span class="relative inline-block align-text-bottom">
|
||||
{{ partial "icon.html" .Params.icon }}
|
||||
</span>
|
||||
</div>
|
||||
<div>
|
||||
<h3 class="flex text-xl font-semibold">
|
||||
{{ .Title }}
|
||||
</h3>
|
||||
<p class="text-sm text-neutral-400">
|
||||
{{ .Description }}
|
||||
</p>
|
||||
</div>
|
||||
</a>
|
||||
</article>
|
||||
{{ end }}
|
||||
</section>
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
尽管这是一个比较简单的例子，但你可以看到这里的 `list.html` 文件遍历了本节中的所有子页面，然后输出了每个页面的 HTML 链接 和图标。每个项目的扉页参数被用来确定显示哪些信息。
|
||||
Although this is quite a straightforward example, you can see that it steps through each of the pages in this section (ie. each project), and then outputs HTML links to each project alongside an icon. The metadata in the front matter for each project is used to determine which information is displayed.
|
||||
|
||||
请记住，构建网站的时候需要重新编译 Tailwind CSS，一定要确保相关的样式和类可用。这在[高级定制]({{< ref "advanced-customisation" >}})部分有更详细的说明。
|
||||
|
||||
当尝试使用自定义模板时，请务必先了解默认的 Blowfish 模板是如何工作的，然后将其作为指南或模板。补充一点，[Hugo 文档](https://gohugo.io/templates/introduction/) 也是学习创建自定义模板的宝贵资源。
|
||||
|
|
@ -260,7 +260,7 @@ Blowfish 还支持嵌套菜单。你需要在`menu.toml` 中定义一个父级
|
|||
|
||||
## 缩略图 & 背景
|
||||
|
||||
Blowfish 的创立开端旨在便于为文章添加视觉效果。如果你熟悉 Hugo 的文章结构，只需要在您文章所在的文件夹中，放置一个以`feature*`开头的图像文件（Blowfish支持所有格式的文件，但更推荐使用 `.png` 或 `.jpg`）。就这样，Blowfish 就能够将图像文件作为文章的缩略图，而且能够在社交平台的 `<a target="_blank" href="https://oembed.com/">oEmbed</a>` 卡片中使用。
|
||||
Blowfish 的创立开端旨在便于为文章添加视觉效果。如果你熟悉 Hugo 的文章结构，只需要在你文章所在的文件夹中，放置一个以`feature*`开头的图像文件（Blowfish支持所有格式的文件，但更推荐使用 `.png` 或 `.jpg`）。就这样，Blowfish 就能够将图像文件作为文章的缩略图，而且能够在社交平台的 `<a target="_blank" href="https://oembed.com/">oEmbed</a>` 卡片中使用。
|
||||
|
||||
[这里]({{< ref "thumbnails" >}}) 有一个指南，提供了个人更多的内容和[示例]({{< ref "thumbnail_sample" >}})。如果你想看看具体如何操作可以看这里。
|
||||
|
||||
|
|
|
|||
91
exampleSite/content/docs/homepage-layout/index.zh-cn.md
Normal file
91
exampleSite/content/docs/homepage-layout/index.zh-cn.md
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
---
|
||||
title: "主页布局"
|
||||
date: 2020-08-13
|
||||
draft: false
|
||||
description: "在 Blowfish 主题中设置主页布局。"
|
||||
slug: "homepage-layout"
|
||||
tags: ["主页", "布局", "文档"]
|
||||
series: ["文档集"]
|
||||
series_order: 5
|
||||
---
|
||||
|
||||
Blowfish 提供了一个完全灵活的主页布局。你可以选择两种主要模板，并提供了额外的参数来帮助调整设计。当然，你也可以提供自己的模板，完全控制主页的内容。
|
||||
|
||||
主页布局由 `params.toml` 配置文件中的 `homepage.layout` 参数来控制的。此外所有布局都默认包括 [最近文章](#recent-articles)。
|
||||
|
||||
## 个人资料布局 (profile)
|
||||
|
||||
默认的布局是 profile 布局，这非常适合个人网站和博客。它将作者的详细信息置于中心位置，并附带了头像和社交平台的链接。
|
||||
|
||||
<img class="thumbnailshadow" src="img/home-profile.png"/>
|
||||
|
||||
作者信息是在语言配置文件中提供的。具体的参数详情，请参考[快速入门]({{< ref "getting-started" >}})和[语言配置]({{< ref "configuration##language-and-i18n" >}})的内容。
|
||||
|
||||
此外，主页内容中提供的任何 Markdown 都会显示在作者资料的下方。这对使用短代码显示简介或其他主页的自定义内容提供了更多的灵活性。
|
||||
|
||||
如果想要启用 profile 布局，请在 `params.toml` 配置文件中设置 `homepage.layout = "profile"`。
|
||||
|
||||
## 页面布局（page）
|
||||
|
||||
页面布局只会简单的显示你的 Markdown 内容，这种方式非常适合静态网站，并提供了很多灵活性。
|
||||
|
||||
<img class="thumbnailshadow" src="img/home-page.png"/>
|
||||
|
||||
如果想要启用 page 布局，请在 `params.toml` 配置文件中设置 `homepage.layout = "page"`。
|
||||
|
||||
## 英雄布局（hero）
|
||||
|
||||
英雄布局（hearo）组合了个人资料布局（profile）和卡片布局（card）。它不仅显示了网站作者的个人信息，还在个人资料下方加载了你的 markdown 内容。
|
||||
|
||||
<img class="thumbnailshadow" src="img/home-hero.png"/>
|
||||
|
||||
如果想要启用 hero 布局，请在 `params.toml` 配置文件中设置 `homepage.layout = "hero"`。
|
||||
|
||||
## 背景布局（background）
|
||||
|
||||
背景布局（background）相对于英雄布局（hero）更叫平滑。和英雄布局（hero）类似，它也显示了网站作者的信息，并在其下方加载 markdown 内容。
|
||||
|
||||
<img class="thumbnailshadow" src="img/home-background.png"/>
|
||||
|
||||
如果想要启用 background 布局，请在 `params.toml` 配置文件中设置 `homepage.layout = "background"` 和 `homepage.homepageImage` 。
|
||||
|
||||
## 卡片布局（card）
|
||||
|
||||
卡片模板（card）是在页面布局上的扩展，它同样提供了灵活性。在显示了你的 markdown 内容的同时，展示了一个卡片组件中的图像。
|
||||
|
||||
<img class="thumbnailshadow" src="img/home-card.png"/>
|
||||
|
||||
如果想要启用 card 布局，请在 `params.toml` 配置文件中设置 `homepage.layout = "card"` 和 `homepage.homepageImage` 。
|
||||
|
||||
## 自定义布局（custom）
|
||||
|
||||
如果以上几个布局还没有满足你的需求，你还可以自己创建自定义布局。这样你可以基于一个空白的画布，来完全控制页面上的内容。
|
||||
|
||||
如果想要启用 custom 布局，请在 `params.toml` 配置文件中设置 `homepage.layout = "custom"` 。
|
||||
|
||||
配置好参数后，在 `layouts/partials/home` 目录下创建一个 `custom.html` 文件。 `custom.html` 文件中定义的任何内容都会被放置在网站主页的内容区域。你可以使用 HTML、Tailwind 或 Hugo 模板函数来定义你的布局。
|
||||
|
||||
如果你想在自定义布局上添加 [最近文章](#recent-articles)，请使用 `recent-articles/main.html` 中的内容。
|
||||
|
||||
如果你想在网站[主页]({{< ref "/" >}})使用自定义布局来实现在个人资料和页面布局之间的切换。这里的[GitHub 仓库](https://github.com/nunocoracao/blowfish/blob/main/exampleSite/layouts/partials/home/custom.html)有一个例子可以参考。
|
||||
|
||||
## 最近文章
|
||||
|
||||
所有的主页布局都可以在主要内容下方显示最近文章。如果想要启用此功能，只需要在 `params.toml` 配置文件中将 `homepage.showRecent` 参数设置为 `true` 即可。
|
||||
|
||||
<img class="thumbnailshadow" src="img/home-list.png"/>
|
||||
|
||||
这部分会列举出你在 `mainSections` 参数中设置的文章列表，此参数允许你使用网站上的任何内容类型。例如，如果你想在最新文章中展示 _posts_ 和 _projects_ 内容中的文章，你可以将此值设置为 `["posts", "projects"]`，这两个部分中的所有文章都会填充到最近文章列表中。Blowfish 主题期望这个参数是一个数组，如果你只想设置一个部分的所有文章，你可以设置为 `["blog"]` 即可。
|
||||
|
||||
## 缩略图
|
||||
|
||||
Blowfish 为你的文章提供了视觉支持。如果你熟悉 Hugo 的文章结构，只需要在你的文章对应的文件夹中防止一个以`feature*`开头的图像文件即可，图像类型几乎支持所有格式，更推荐使用`.png` 或者 `.jpg`。这样一来，Blowfish 将会在你的网站内使用该图片作为缩略图，并用在社交媒体平台上的 <a target="_blank" href="https://oembed.com/">oEmbed</a> 卡片中。
|
||||
|
||||
[这是]({{< ref "thumbnails" >}})有更多详细内容，并且有一个便于理解的[示例]({{< ref "thumbnail_sample" >}})。
|
||||
|
||||
## 卡片画廊
|
||||
|
||||
Blowfish 支持将标准的文章列表显示为卡片画廊，你可以在主页的最近文章和网站上的文章列表中配置这个选项。
|
||||
- 对于主页可以使用 `homepage.cardView` 和 `homepage.cardViewScreenWidth` 参数
|
||||
- 对于列表页可以使用 `list.cardView` 和 `list.cardViewScreenWidth` 参数
|
||||
请查看 [配置文件]({{< ref "configuration" >}}) 以获取更多信息。
|
||||
|
|
@ -30,7 +30,7 @@ A highly requested feature, Blowfish is now multilingual! If you publish your co
|
|||
|
||||
<div class="text-2xl text-center" style="font-size: 2.8rem">:gb: :de: :fr: :es: :cn: :brazil: :tr: :bangladesh:</div>
|
||||
|
||||
感谢社区的贡献，目前 Blowfish 已经翻译成二十六种语言，并且随着时间的推移还会支持更多。 顺便一提，欢迎您为支持新语言提交 [PR](https://github.com/nunocoracao/blowfish/pulls)。
|
||||
感谢社区的贡献，目前 Blowfish 已经翻译成二十六种语言，并且随着时间的推移还会支持更多。 顺便一提，欢迎你为支持新语言提交 [PR](https://github.com/nunocoracao/blowfish/pulls)。
|
||||
|
||||
## 支持 RTL 语言
|
||||
|
||||
|
|
@ -89,4 +89,4 @@ Blowfish 2.0版本的重大变化是增加了自动调整图片大小的功能
|
|||
|
||||
欢迎来尝试和探索强大而轻量的 Blowfish 2.0，打造优雅、个性化的创作之旅！
|
||||
|
||||
如果您对 Blowfish 有更加创意的想法，欢迎随时[提交](https://github.com/nunocoracao/blowfish/discussions)，期待与您共同营造 Blowfish 的开源文化！
|
||||
如果你对 Blowfish 有更加创意的想法，欢迎随时[提交](https://github.com/nunocoracao/blowfish/discussions)，期待与你共同营造 Blowfish 的开源文化！
|
||||
|
|
@ -18,7 +18,7 @@ cardViewScreenWidth: true
|
|||
|
||||
{{< alert >}}
|
||||
|
||||
**您是 Blowfish 用户 ？** 请在这个列表中添加您的站点, [提交 PR](https://github.com/nunocoracao/blowfish/blob/main/exampleSite/content/users/users.json).
|
||||
**你是 Blowfish 用户 ？** 请在这个列表中添加你的站点, [提交 PR](https://github.com/nunocoracao/blowfish/blob/main/exampleSite/content/users/users.json).
|
||||
|
||||
{{</ alert >}}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue