タグの使い方 (tags 機能のまとめ)
設定方法
- front matter に書くだけ
- 複数指定できるので、
[ .. ]で配列になっている
---
tags: ["docusaurus"]
---
".."または'..'で囲う (ascii 文字のみのときは省略可だが、どっちだっけと迷いたくないので囲う)
URL
このような URL で参照できるようになる
設定
docs 直下に tags.yml を置いておけば、説明やラベルを定義できる。
tags.yml
docusaurus:
label: Docusaurus
permalink: /docusaurus
description: Docusaurus は、このサイトのようなドキュメント管理サイトを構築できる、静的サイトジェネレータです
- label : 一覧などでの表示名を変えたければ指定
- permalink : URLでの表示名を変えたければ指定 (または、
memo/docusaurusのように階層を掘りたいとき) - description : 一覧などでの説明文を指定したければ指定。1行のテキストで指定。
<br/>などと書いても無駄。そのまま出る
リンク例：
省略時の動作
- tags.yml ファイル自体ない場合も、デフォルト動作となるだけ
- tags.yml ファイル内の 各項目は それぞれ省略可
- tags.yml ファイル作成後は、定義されていない tag を md ファイルで使用しても、でエラーとはならないが、run start 時に警告は出してくれる
補足: description についての自分用メモ
- 「このタグを選んだときに何が得られるのか」を初見でも理解できるのを意識
- 個人的感想などを書きたければカッコ内にでも留めておこう
こういうこと
description: Docusaurus は、このサイトのようなドキュメント管理サイトを構築できる静的サイトジェネレータです (本来は技術メモをまとめるために導入したはずが、肝心の内容よりも Docusaurus のメモばかりが充実していく始末。 きっと最初だけだと自分に言い聞かせる...)