(Translated by https://www.hiragana.jp/)
GitHub - curegit/nagoya: レスポンシブ対応、日本語特化 Hugo ブログテーマ
Skip to content
/ nagoya Public

レスポンシブ対応たいおう日本語にほんごとく Hugo ブログテーマ

License

Notifications You must be signed in to change notification settings

curegit/nagoya

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nagoya

Nagoya (名古屋なごや) は、静的せいてきサイトジェネレーター Hugo よう日本語にほんごブログテーマです。 日本語にほんごのユーザーに最適さいてきになるよう設計せっけいされています。

デモサイト: https://curegit.github.io/nagoya-example/

デモサイトのソース: https://github.com/curegit/nagoya-example

主要しゅよう機能きのう

  • レスポンシブデザイン
  • サムネイル画像がぞう表示ひょうじ
  • ディレクトリツリーによる整理せいり
  • テキストマッチングによる記事きじ簡易かんい全文ぜんぶん検索けんさく
  • 数式すうしきレンダリング (KaTeX)
  • ダイアグラム表示ひょうじ (Mermaid)
  • パンくずリスト
  • Open Graph Protocol
  • 構造こうぞうデータマークアップ (microdata)

提供ていきょうしない機能きのう

  • i18n(国際こくさい対応たいおう

    このテーマは Monolingual project のみ対応たいおうします。

  • ソーシャルメディアのリンク表示ひょうじ

インストール

Git submodule による導入どうにゅう推奨すいしょうします。

git submodule add --name nagoya https://github.com/curegit/nagoya.git themes/nagoya

SCSS 拡張かくちょう (Hugo extended edition) は不要ふようです。

基本きほん設計せっけい

Hugo のページバンドルによるコンテンツ整理せいりしたがっており、任意にんいふかさのセクションツリーを作成さくせいできます。 このテーマでは、リーフバンドルを通常つうじょう記事きじとしてあつかいます。

サムネイル画像がぞう設定せってい方法ほうほう

Hugo 自体じたい挙動きょどうせており、フロントマターの imagesがあればそれをサムネイルとして使用しようします。 それがない場合ばあいは、バンドルないでファイルめいに feature, cover, thumbnail がふくまれる画像がぞうがサムネイルとして使つかわれます。

タグやカテゴリ (Taxonomies)

このテーマでは tag と archive と search が特別とくべつあつかいされます。

これらを有効ゆうこうする場合ばあい、tag, search, archive の複数ふくすうがたは、それぞれ tags, search, archives と設定せっていされる必要ひつようがあります。

  • tag はサイドバーなどに独自どくじのアイコンきで表示ひょうじされます
  • かく記事きじのメタタグのキーワードは設定せっていされた tag をもと自動的じどうてき設定せっていされます
  • archive を有効ゆうこうすると、年別ねんべつにグループされたぜん記事きじ一覧いちらんページが生成せいせいされます
  • archive のとしdate 属性ぞくせいから自動じどう計算けいさんされるため、かく記事きじで archives パラメータを設定せっていする必要ひつようはありません
  • search を有効ゆうこうすると、テキストマッチングによる記事きじ簡易かんい全文ぜんぶん検索けんさく機能きのう (Web Worker を使用しよう) が利用りようできます
  • search と archive は、独自どくじ動的どうてきなタームページを提供ていきょうするので、かく記事きじでのタームパラメータの設定せってい無効むこうです
  • search と archive は、リーフバンドルのみを対象たいしょうとし、さらに固定こていページは除外じょがいされます

なお、Taxonomy 表示ひょうじ日本語にほんごするためには、該当がいとうするセクション(archives や categories)に _index.md ファイルを作成さくせいし、そのなかtitle パラメータを設定せっていしてください。

設定せっていれい: hugo.toml

[taxonomies]
  category = "categories"
  tag = "tags"
  archive = "archives"
  search = "search"

設定せっていれい: /content/categories/_index.md

---
title: カテゴリ
---

メニューとウィジェット

Hugo の Menu Templates 機能きのうには対応たいおうしていません。 /layouts/partials/widgets/ うちにある、配置はいちしたい該当がいとう場所ばしょ部分ぶぶんのパーシャルレイアウトをオーバーライドしてメニューを作成さくせいします。

/layouts/partials/widgets/ うちのオーバーライドは、カスタムウィジェットの作成さくせいにも利用りようできます。

サイトパラメータ

以下いかは、hugo.toml設定せっていできるサイト全体ぜんたい効果こうかがある params です。

キー かた 説明せつめい
author String サイト全体ぜんたい著者ちょしゃめい指定していします
authorLink String 著者ちょしゃページまたはメールアドレスのハイパーリンクを設定せっていします
description String サイトの概要がいよう設定せっていします
keywords Array of String サイト全体ぜんたいのキーワードを設定せっていします
showAuthor Boolean 著者ちょしゃ情報じょうほう記事きじ表示ひょうじするかかを設定せっていします
showLastmod Boolean かく記事きじ最終さいしゅう更新こうしん表示ひょうじするかかを設定せっていします
showSummary Boolean リストページに Summary を表示ひょうじするかかを設定せっていします
showTreeCount Boolean サイドバーのディレクトリツリーにけいページすう表示ひょうじするかかを設定せっていします
treeRoot String サイドバーのディレクトリツリーの起点きてん指定していします
sidebarSearch Boolean サイドバーに検索けんさくボックスを表示ひょうじするかかを設定せっていします
newNum Integer サイドバーに表示ひょうじする最新さいしん記事きじかず設定せっていします
newText String サイドバーに表示ひょうじする最新さいしん記事きじ領域りょういきのタイトルを設定せっていします
readNextText String かく記事きじ下部かぶ表示ひょうじする記事きじリスト領域りょういきのタイトルを設定せっていします
relatedNum Integer かく記事きじ下部かぶ表示ひょうじする記事きじリストにおける関連かんれん記事きじかず設定せっていします
randomNum Integer かく記事きじ下部かぶ表示ひょうじする記事きじリストにおけるランダム記事きじかず設定せっていします
shuffleSeeAlso Boolean 関連かんれん記事きじとランダム記事きじ順序じゅんじょをシャッフルするかかを設定せっていします
showHeaderText Boolean ヘッダーにサイトの概要がいようテキストを表示ひょうじするかかを設定せっていします
headerText String ヘッダーのサイト概要がいようテキストを手動しゅどう設定せっていします
maxConcurrency Integer 検索けんさく機能きのう使つかう Web Worker の最大さいだいすう指定していします

ページパラメータ

フロントマターの params設定せっていできるものとして以下いかがあります。

キー かた 説明せつめい
author String 明示めいじてきにそのページの著者ちょしゃめい設定せっていし、サイト全体ぜんたい著者ちょしゃめいたいして上書うわがきします
authorLink String 著者ちょしゃページへのハイパーリンク、または著者ちょしゃメールアドレスをあらわすリンクを設定せっていします
description String Hugo の Summary のわりに、手動しゅどう記事きじ説明せつめい上書うわがきします
keywords Array of String このページのキーワードを設定せっていし、タグによるキーワード設定せってい上書うわがきします
lang String このページの言語げんご明示めいじし、サイト全体ぜんたい言語げんご設定せってい上書うわがきします
pin Boolean このページへのリンクをサイドバーにピンめします(リーフバンドル専用せんよう
page Boolean このページを記事きじではなく、固定こていページとしてあつかいます(リーフバンドル専用せんよう

記事きじない汎用はんようスタイリング

コンテンツない使用しようできるスタイリングようユーティリティがいくつかあります。

セレクタ 説明せつめい
.red 赤字あかじにします
.bordered 要素ようそわくけます(figure 要素ようそ場合ばあい中身なかみけます)

その備考びこう

  • CDN 経由けいゆまれるリソース (KaTeX, Mermaid) を事前じぜんバンドルする場合ばあいは、リソースをダウンロードして配置はいちし、部分ぶぶんのパーシャルレイアウトを上書うわがきしてください。
  • トップページ内容ないようはじまり部分ぶぶんは、コンテンツルートの _index.md制御せいぎょできます。 タイトルをそらにすることもできます。
  • Hugo サイト設定せっていdisableKinds において、テーマ設計せっけい整合せいごうてき無効むこうできるものは 404, robotstxt, rssかぎります。

ライセンス

MIT