入门

Scientific Python Hugo 主题是用于 Hugo 静态网站生成器的主题，灵感来自 PyData Sphinx 主题。

要在您的网站上使用此主题，请按照以下说明操作

依赖项#

  1. 安装 Hugo。Hugo 的标准版或扩展版都可以使用。

    验证 hugo 是否在您的 PATH 中

    $ hugo version
hugo v0.120.3-a4892a07b41b7b3f1f143140ee4ec0a9a5cf3970 linux/amd64 BuildDate=2023-11-01T17:57:00Z VendorInfo=gohugoio

  2. 安装 Dart Sass.

您还可以 将 Hugo 作为 snap 安装，其中包含 Dart Sass。

设置主题#

此主题旨在用作您网站源代码库中的 Git 子模块。

  1. 如果您还没有，请为您的新网站创建一个 Git 仓库

    mkdir NEW-SITE
cd NEW-SITE
git init

  2. 将主题仓库添加为子模块

    git submodule add https://github.com/scientific-python/scientific-python-hugo-theme themes/scientific-python-hugo-theme

  3. 将主题的文档站点复制为网站模板

    cp -a themes/scientific-python-hugo-theme/doc/* .

  4. 测试网站

    $ make serve
...
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)

    在浏览器中加载该 URL。如果您看到了主题的文档页面，则网站编译成功，您可以使用自己的内容对其进行自定义。

开发您的网站#

通过添加内容和自定义资源（如 CSS 或 JavaScript）来继续开发您的网站。

使用 make serve 启动的 Web 服务器会在每次更改网站时重新编译网站，并自动刷新浏览器。

内容#

将 Markdown 文件放置在 ./contents/ 中。另请参阅 Hugo 文档。

config.yaml#

您的网站配置文件是 ./config.yaml。它用于设置网站名称、配置导航栏等。示例 config.yaml 文件可以在 scientific-python.org、numpy.org 和 scipy.org 中看到。

CSS#

要自定义样式，请将 CSS（.css）和 Sass（.scss）文件添加到 ./assets/css/ 目录中。建议将您的自定义内容放在名为 custom.css 的文件中，但添加到其中的其他 .css 和 .scss 文件也会加载。

CSS 和 SCSS 文件作为 Hugo 模板进行编译，即可以访问 config.yaml 文件中的配置变量，例如 {{ .Site.Params.VARIABLE }}。

JavaScript#

将自定义 JavaScript 文件添加到 ./static/js/ 目录中，并使用 .js 扩展名。它们将自动包含在生成的页面中。

部署您的网站#

使用 make html 构建您的网站以进行部署。生成的网站位于 ./public 中。

后续步骤#

花点时间了解主题提供的 功能 和 短代码。

本页面