hugo book下载 - hugo book源代码下载

hugo book

其他源码

1.0.0

下载

Hugo Book 主题 - HOT fork

Hugo 文档主题就像普通书一样简单

特征

干净简单的设计
移动友好
可定制
旨在不干扰其他布局
零初始配置

要求

雨果 0.43 或更高
Hugo 扩展版，请在此处阅读更多内容

安装

导航到您的hugo 网站根目录并运行：

git submodule add https://github.com/alex-shpak/hugo-book themes/book

然后运行hugo（或者在配置文件中设置theme: book ）

hugo server --theme book

菜单

文件树菜单（默认）

默认情况下，主题会将content/docs部分的页面呈现为树结构中的菜单。
您可以在页面前面设置title和weight ，以调整菜单中的顺序和标题。

叶束菜单

您还可以使用叶包及其index.md的内容作为菜单。

鉴于你有这个文件结构

├── content
│   ├── docs
│   │   ├── page-one.md
│   │   └── page-two.md
│   └── posts
│       ├── post-one.md
│       └── post-two.md

使用内容创建文件content/docs/menu/index.md

 ---headless: true---- [书籍示例](/docs/)
  - [第一页](/docs/page-one)
  - [第二页](/docs/page-two)- [博客](/posts)

并通过在站点配置中设置BookMenuBundle: /docs/menu来启用它

菜单示例
配置文件示例
叶束

博客

支持版块posts的简单博客

配置

站点配置

您可以将一些配置选项添加到config.yml|json|toml文件中

# （可选）如果在文件名中使用大写字母，则将此设置为 truedisablePathToLower: true# （可选）将其设置为 true 以在“doc”类型的页面上启用“最后修改者”日期和 git 作者#信息。enableGitInfo: true# （警告）主题用于文档使用，因为它不会呈现分类法。#您可以使用下面的配置隐藏相关警告disableKinds: ["taxonomy", "taxonomyTerm"]params: # (可选, 默认 true) 全局显示或隐藏目录
  # 你也可以在前面的内容中每页指定这个参数
  BookShowToC：正确

  # （可选，默认无）设置叶束渲染为侧边菜单
  # 当未指定文件结构和权重时将使用
  BookMenuBundle：/菜单

  # （可选，默认文档）指定要呈现为菜单的内容部分
  # 您还可以将值设置为“*”以将所有部分呈现到菜单
  图书部分：文档

  # 该值与 $link-color 重复，用于在菜单捆绑模式下突出显示活动链接
  # BookMenuBundleActiveLinkColor: #004ed0

  # 在页面中包含 JS 脚本。默认禁用。
  # - 在导航过程中将侧边菜单保持在相同的滚动位置
  BookEnableJS：true

  # 设置源存储库位置。
  # 用于“上次修改”和“编辑此页面”链接。
  BookRepo：https://github.com/alex-shpak/hugo-book

  # 为“doc”页面类型启用“编辑此页面”链接。
  # 默认情况下禁用。取消注释以启用。需要“BookRepo”参数。
  # 路径必须指向存储库的“内容”目录。
  BookEdit路径：edit/master/exampleSite/content

页面配置

您可以在前面的内容中指定每页的附加参数

---# 如果要在配置的部分之外渲染页面，或者渲染“docs”类型以外的部分，请将类型设置为“docs”：docs# 设置页面权重以重新排列文件树菜单中的项目（如果 BookMenuBundle未设置)weight: 10# (可选) 设置为在文件树菜单中将页面标记为平面部分 (如果 BookMenuBundle 未设置)bookFlatSection: true# (可选) 设置为隐藏目录，覆盖全局valuebookShowToC: false---

偏音

您可以在layouts/partials/中覆盖一些空的部分

部分的	放置
`layouts/partials/docs/inject/head.html`	关闭`<head>`标签之前
`layouts/partials/docs/inject/body.html`	关闭`<body>`标签之前
`layouts/partials/docs/inject/menu-before.html`	在`<nav>`菜单块的开头
`layouts/partials/docs/inject/menu-after.html`	在`<nav>`菜单块的末尾