hugo bookダウンロード - hugo bookソースコードダウンロード

hugo book

その他のソースコード

1.0.0

ダウンロード

Hugo Book テーマ - HOT フォーク

普通の本と同じくらいシンプルな Hugo ドキュメントのテーマ

スクリーンショット

特徴

すっきりとしたシンプルなデザイン
モバイルフレンドリー
カスタマイズ可能
他のレイアウトを邪魔しない設計
初期設定ゼロ

要件

Hugo 0.43 以降
Hugo 拡張バージョン、詳細はこちら

インストール

Hugo Web サイトのルートに移動し、次を実行します。

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/)
  - [ページ 1](/docs/page-one)
  - [ページ 2](/docs/page-two)- [ブログ](/posts)

そして、サイト設定のBookMenuBundle: /docs/menu設定で有効にします。

メニュー例
設定ファイルの例
葉束

ブログ

シンプルなブログのセクションpostsのサポート

構成

サイト構成

config.yml|json|tomlファイルに追加できる構成オプションはいくつかあります。

 # (オプション) ファイル名に大文字を使用する場合はこれを true に設定しますdisablePathToLower: true# (オプション) 「doc」タイプのページで「最終更新者」日付と git author# 情報を有効にするには、これを true に設定します。enableGitInfo: true# (警告) テーマはドキュメントでの使用を目的としており、分類法は表示されません。# 以下の設定を使用して関連する警告を非表示にできますdisableKinds: ["taxonomy", "taxonomyTerm"]params: # (オプション、デフォルトは true) 目次をグローバルに表示または非表示にする
  # このパラメータは前付のページごとに指定することもできます
  BookShowToC: true

  # (オプション、デフォルトはなし) サイド メニューとしてレンダリングするリーフ バンドルを設定します
  # 指定されていない場合はファイル構造と重みが使用されます
  ブックメニューバンドル: /menu

  # (オプション、デフォルトのドキュメント) メニューとしてレンダリングするコンテンツのセクションを指定します
  # 値を「*」に設定して、すべてのセクションをメニューに表示することもできます
  本セクション: ドキュメント

  # この値は、メニュー バンドル モードでアクティブなリンクを強調表示するための $link-color と重複します。
  # BookMenuBundleActiveLinkColor: #004ed0

  # JS スクリプトをページに含めます。デフォルトでは無効になっています。
  # - ナビゲーション中、サイド メニューを同じスクロール位置に維持します
  BookEnableJS: true

  # ソースリポジトリの場所を設定します。
  # 「最終更新日」および「このページを編集」リンクに使用されます。
  BookRepo: https://github.com/alex-shpak/hugo-book

  # 「doc」ページタイプの「このページを編集」リンクを有効にします。
  # デフォルトでは無効になっています。有効にするにはコメントを外します。 「BookRepo」パラメータが必要です。
  # パスはリポジトリの「content」ディレクトリを指す必要があります。
  BookEditPath: edit/master/exampleSite/content

ページ構成

前付のページごとに追加のパラメータを指定できます

---# 構成されたセクションの外側でページをレンダリングする場合、または「docs」以外のセクションをレンダリングする場合は、タイプを「docs」に設定します。type: 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>`メニューブロックの最後