2023-07-10 17:44:03 +02:00
|
|
|
|
# **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.
|
|
|
|
|
|
2023-07-17 18:42:23 +02:00
|
|
|
|
## 移行作業
|
2023-07-10 17:44:03 +02:00
|
|
|
|
|
|
|
|
|
- `.docs-legacy/`内にvuepress時代のファイルを格納
|
2023-07-17 18:42:23 +02:00
|
|
|
|
- `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の統一のため、末尾にスラッシュが付くようになっています。
|
|
|
|
|
|
2023-11-26 07:51:03 +01:00
|
|
|
|
内部のリンクの切り分け処理が複雑になっているため、技術的なことがよくわかっていない場合や、自前でデバッグ環境を作成してリンクの検証ができない方は**絶対パスを使うことをおすすめします。**
|
2023-07-17 18:42:23 +02:00
|
|
|
|
|
2023-11-26 07:49:35 +01:00
|
|
|
|
VuePressでは末尾が`.md`となるパス形式でしたが、Misskey-Hub-Nextではコレは許容されません。実際のWebサイト上でのパスを入力してください。
|
|
|
|
|
|
|
|
|
|
ただし、リンクは自動的に言語ごとのものに変換されますので、**マークダウン内で`/ja/`などの言語プレフィックスを付与しないようにしてください。**
|
2023-11-11 13:03:15 +01:00
|
|
|
|
|
2023-12-01 18:34:15 +01:00
|
|
|
|
## 独自コンポーネントについて
|
|
|
|
|
|
|
|
|
|
Nuxt Contentは、内部的にはmarkdownの拡張言語であるMDCを採用しています。
|
|
|
|
|
|
|
|
|
|
MDC記法でのVueコンポーネントの書き方は、[こちら](https://content.nuxt.com/usage/markdown#vue-components)をご確認ください。
|
|
|
|
|
(特に、コンポーネントをネストする際の記法に気を付けてください)
|
|
|
|
|
|
2023-11-11 13:03:15 +01:00
|
|
|
|
## 独自Frontmatterについて
|
|
|
|
|
|
|
|
|
|
### `date`
|
|
|
|
|
(ブログのみ)公開時刻をオーバーライドできます。
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
date: 2023-11-11
|
|
|
|
|
```
|
|
|
|
|
|
2023-11-30 13:57:24 +01:00
|
|
|
|
### `thumbnail`
|
|
|
|
|
(現状ブログのみ)サムネイル画像を設定できます。URLまたはサイトディレクトリの絶対パスを入力してください
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
thumbnail: /img/blog/foo/bar.png
|
|
|
|
|
```
|
|
|
|
|
|
2023-11-11 13:03:15 +01:00
|
|
|
|
### `maxTocDepth`
|
2023-11-11 13:59:03 +01:00
|
|
|
|
(Docsのみ)もくじの見出しを遡る限度を指定できます。`<h2>`タグまでにしたい場合は`2`を指定します。
|
2023-11-11 13:03:15 +01:00
|
|
|
|
|
|
|
|
|
```yml
|
2023-11-11 13:59:03 +01:00
|
|
|
|
maxTocDepth: 2
|
2023-11-11 13:03:15 +01:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### `ignoreDirBasedNav`
|
2023-11-11 17:09:52 +01:00
|
|
|
|
(Docsのみ)`true` にすると、前へ・次へボタンを、前後のページの階層に関係なく表示します。
|