はじめに

  • RAIZINのサイトでは、記事が増えましたのでHugoのドキュメント管理機能をフルに使ったサイトにリニューアルしました。
  • 本サイトで、ドキュメント管理機能を楽しんでください。
  • 旧サイトは、「　https://raizin-site.netlify.app/　」　に置いてあります。
1. Hugoを使ったドキュメント管理
  1. 実用的で信頼性の高いドキュメント サイトを迅速に稼働させ、ユーザーにとって優れたコンテンツに集中することができます。
  2. 大規模な文書セットに対して便利な文庫構造のスケルトンを自由に設計できます。
  3. マークダウン(Markdown)形式ですの統一化された文書様式が設計できます。
  4. データベースを使いませんので、文庫構造の追加・変更が簡単にできます。
  5. カテゴリ、タグ、作成者、日時、公開・非公開、表示順位などの要素が追加できます。
  6. 非公開の文庫を運営することも可能です。
2. フロントマター(Front Matter)

  1. Hugo では、コンテンツ（Markdownファイル）のタイトル、日付、カテゴリや任意のパラメータ等のメタデータを追加することができます。 メタデータはコンテンツファイルの先頭で指定しますが、この部分をフロントマターと呼びます。

  2. フロントマターの例

  • yaml形式です。
  • サイドバーへの表示、表示順、タグ、カテゴリを設定しています。
    - - -
title: "サイトのリニューアル"
published: true
date: 2022-07-10T08:06:25+06:00
description: "RAIZIN Inc.のサイトをリニューアルしました。"
menu:
  sidebar:
    name: "サイトのリニューアル"
    identifier: 001-open
    parent: 10-2023
    weight: 10001
tags: ["サイト","RAIZIN","ドキュメント","DX","ペーパレス","Hugo"]
categories: ["Basic", "ニュース"]
hero: 001s.webp
- - -
3. 必須パラメータ
  • title コンテンツのタイトル
  • date コンテンツの日付（ソートに使用されます）
4. オプションパラメータ
  • description コンテンツの説明文
  • draft: 下書きフラグ true に設定するとビルド時に –buildDrafts オプションを つけなければページが生成されません。
  • publishdate: 発行日 true に設定するとビルド時に –buildFuture オプションを つけなければページが生成されません。
  • type: コンテンツのタイプ 詳しくは前回のエントリを参照ください。
  • isCKJLanguage: 日本語韓国語中国語を含む場合は true を設定してください。 サマリーや文字数カウントに影響します。 config.toml の hasCJKLanguage を true にすると 自動判定されますので省略可能です。
  • weight: エントリの並び順を変更する時に使用します。
  • slug: URLの末尾、ファイル名部分を変更します。 詳しくは前回のエントリを参照ください。
  • url: URLを変更します。 詳しくは前回のエントリを参照ください。-
5. カテゴリ・タグ

  • Hugo ではコンテンツをグルーピングするカテゴリやタグ等の分類のことを taxonomies と呼びます。

  • コンテンツで指定した taxonomies は、画面に表示したり、グルーピングしたコンテンツのリストページの生成に使用できます。

  • categories, tags 以外の taxonomies を追加する場合は config.toml に定義を追加できます。

  • 設定の例です。

    [taxonomies]
  tag = "tags"
  category = "categories"
  series = "series"
6. ユーザ定義パラメータ
  • Hugo では、コンテンツに対して上で紹介した以外の任意のパラメータを追加することができます。
以上