特性

Hugo 布局#

  • _default/single.html：单个页面布局
  • _default/section.html：章节布局（一个章节通常包含 _index.md 并包含其他页面）

博客文章布局

  • layouts/partials/posts/post.html：博客文章布局
  • layouts/partials/posts/list.html：博客文章列表布局
  • layouts/partials/posts/tag.html：标签页面布局
  • layers/partials/posts/comments.html：默认情况下为空；可以覆盖以放置评论部分

添加自定义 HTML 头部内容#

  • layouts/partials/head.html

快捷方式列表#

每个帖子左侧快捷方式列表的深度可以通过在帖子序言中设置 shortcutDepth 参数来控制。默认值为 2。

页面信息#

每个页面都应该在序言中包含一个 summary，否则网站描述将作为元数据提供。

自定义 JavaScript#

自定义 JavaScript 可以添加为 /assets/js/my_js.js（其中 my_js 可以是任何名称）。

新闻#

来自 /content/en/news 的第一篇文章将在首页突出显示。如果您不希望这样，请删除 /content/en/news 文件夹。

默认情况下，新闻项目链接到 /news 类别页面（其中列出所有新闻项目）。您可以通过在任何新闻帖子的序言中设置 newsLink 来覆盖它。

单页面新闻#

如果您希望在一页上列出所有新闻项目，您可以在 /news.md 中执行此操作，而不是将帖子添加到 /news。在该文档的序言中设置 newsHeader 参数以填充首页上的横幅。

tools/team_query.py 文件从 GitHub 获取团队成员列表。要使用它，您需要将 GH_TOKEN 环境变量设置为个人访问令牌。

示例用法

python team_query.py --org scientific-python --team spec-steering-committee --title "Spec Steering Committee" > content/en/teams/spec-steering-committee.md

我们生成一个原始 HTML 画廊，并提供一个短代码（include-html）用于在站点的任何位置提取它。

分析#

该主题通过 Plausible 支持分析，Plausible 可以自托管或在 https://#/ 上付费使用。要启用 Plausible 分析，请添加到您的 config.yaml 中

params:
  plausible:
    dataDomain: your-domain.org
    javaScript: https://your.plausible.io/javascript/path.js

默认情况下，javaScript 指向 https://# 上的服务器。请联系 Scientific Python 团队以将您的分析托管在那里。

图标#

您可以通过从 Google Fonts 下载 Material-UI SVG 到 /assets/icons 目录来添加自定义图标（例如，用于页脚）。

在页脚中，图标的使用方式与主题内置的图标相同。要在其他地方使用它们，例如在 Hugo 模板中，我们提供了一个 svg-icon 部分。例如，/assets/icons/my-icon.svg 使用以下方式显示

{{ partial "svg-icon" "my-icon" }}

Mermaid 图表#

Mermaid 图表从代码块中渲染

```mermaid
graph LR
    A[Square Rect] -- Link text --> B((Circle))
    A --> C(Round Rect)
    B --> D{Rhombus}
    C --> D
```
graph LR
    A[Square Rect] -- Link text --> B((Circle))
    A --> C(Round Rect)
    B --> D{Rhombus}
    C --> D

创建博客#

放置在 content/posts 或 content/blog 下的页面将被格式化为博客文章。

在此页面上