https://github.com/ittokunvim/doc
このリポジトリには、私が作成した色々なドキュメントが保存されています。
https://github.com/ittokunvim/doc
markdown
Last synced: about 2 months ago
JSON representation
このリポジトリには、私が作成した色々なドキュメントが保存されています。
- Host: GitHub
- URL: https://github.com/ittokunvim/doc
- Owner: ittokunvim
- Created: 2021-04-13T17:38:49.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-11-05T10:28:02.000Z (8 months ago)
- Last Synced: 2025-11-05T12:14:57.278Z (8 months ago)
- Topics: markdown
- Language: JavaScript
- Homepage: https://doc.ittokunvim.jp/
- Size: 9.57 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# doc
このリポジトリには、私が作成した色々なドキュメントが保存されています。
また公開するドキュメントを`data.json`にまとめています。
JSON: [data.json](data.json)
## 追加方法
記事を追加する際は以下のルールに従って行うこと。
- `data.json`は以下の形式で追加する。
```json
{
"slug": "how-to-add-article",
"title": "記事を追加する方法",
"description": "ここでは記事を追加する方法について書かれています",
"path": "JUNLE/how-to-add-article/index.md",
"published": true,
"createdAt": "2024-10-12",
"updatedAt": "2024-10-12"
}
```
- ディレクトリ名は`slug`で命名し、ファイル名は`index.md`にする。
- 画像などは作成したディレクトリ下に保存する。
- `README.md`には記事の`title`とリンクを記載して、アクセスできるようにする。