jointrashposs/content/.README.md
2023-11-12 01:09:52 +09:00

1.7 KiB
Raw Blame History

DO NOT edit locale files except ja-JP directory.

When you add files/text to the ja-JP directory (of misskey-dev/misskey-hub), it will automatically be applied to other language files. Translations added in ja-JP file should contain the original Japanese strings.

移行作業

  • .docs-legacy/内にvuepress時代のファイルを格納
  • docs/内にディレクトリ構造を作成中

新規に作成したページ

  • /2.for-users/2.onboarding/index.md 以外
  • /4.for-developers/play/ 以下
  • /4.for-developers/api/index.md を分割

APIリファレンスについて

API リファレンスは移動する予定ですmisskey-jsから自動生成

新しくDocsを作成するかたへ

Nuxtに変更したことに伴い、Canonical URLの統一のため、末尾にスラッシュが付くようになっています。

内部のリンクの切り分け処理が複雑になっているため、絶対パスを使うようにしてください。

なお、リンクは自動的に言語ごとのものに変換されますので、マークダウン内で/ja/などの言語プレフィックスを付与しないようにしてください。

独自Frontmatterについて

date

(ブログのみ)公開時刻をオーバーライドできます。

date: 2023-11-11

maxTocDepth

Docsのみもくじの見出しを遡る限度を指定できます。<h2>タグまでにしたい場合は2を指定します。

maxTocDepth: 2

ignoreDirBasedNav

Docsのみtrue にすると、前へ・次へボタンを、前後のページの階層に関係なく表示します。