From 8891676098aea8dc8586db9c80c479f500ec72b9 Mon Sep 17 00:00:00 2001 From: Ciffelia Date: Wed, 6 Dec 2023 00:50:02 +0900 Subject: [PATCH] Updare README_BLOG.md --- README_BLOG.md | 98 +++++++++++++++++++++++--------------------------- 1 file changed, 45 insertions(+), 53 deletions(-) diff --git a/README_BLOG.md b/README_BLOG.md index bdecb7e..49c4f46 100644 --- a/README_BLOG.md +++ b/README_BLOG.md @@ -2,7 +2,7 @@ OUCC BLOG の仕様について記載しています。何もわからない場合はサーバー係に投稿したい Markdown ファイルを渡してください。 -ブログの投稿を行う際はブランチ名が `blog/` で始まるブランチを作成し作業してください。このブランチではブログの投稿に関する作業以外は禁止されていますが、後述するようにCIによる支援が得られます。 +ブログの投稿を行う際はブランチ名が `blog/` で始まるブランチを作成し作業してください。このブランチではブログの投稿に関する作業以外は禁止されていますが、後述するように投稿日時や更新日時が自動で生成されます。 ブログに関して作業することを明示しつつこの制約を受けたくない場合は、ブランチ名が `blog/admin/` で始まるブランチで作業してください。 @@ -20,6 +20,8 @@ tags: - タグ2 - タグ3 --- + +これは記事本文です。Markdownで文章を書くことができます。 ``` 画像ファイルは `src/content/blogs` に新しいディレクトリを作成してそこに配置するか、または外部においてURLで指定してください。 @@ -28,7 +30,7 @@ tags: ## 記事のメタ情報 -記事のメタ情報には投稿日時と更新日時が含まれています。これは `blog/` から始まるブランチで Pull Request を出すと自動的に更新されます。 +`src/content/blog-metas`にある記事のメタ情報には投稿日時と更新日時が含まれています。これは `blog/` から始まるブランチで Pull Request を出すと自動的に作成・更新されます。 以下のようにコマンドを使うことで手動で更新することもできます。 @@ -36,45 +38,40 @@ tags: $ npm run update-blogmeta -- src/content/blogs/NEW-POST1.md src/content/blogs/NEW-POST2.md ``` -## 著者 +## 著者の追加 + +`src/content/authors` に JSON ファイルを追加することで著者ページを作ることができます。ファイル名は記事の `author` で指定する際の値となるので自身のIDなどわかりやすい名前にしてください。 -`src/content/authors` に JSON ファイルを追加することで新しいタグを作ることができます。ファイル名は記事の `author` で指定する際の値となるのでわかりやすい名前にすることをおすすめします。 著者のスキーマは以下のとおりです。`name` 以外のプロパティは省略可能です。 -- name : 著者の表示名 +- name : 著者の表示名（必須） - description : 著者の説明 -- github : GitHub アカウントの ID (image を指定しなかった場合、こちらで指定したアカウントのアイコンが使用されます。) -- image : 著者のアイコン - - `svg` は `src/assets/icons/blog` に入っているsvgファイルを指定できます。`name` には拡張子を除いたファイル名を指定してください。 - - `external-url` は外部の画像を指定できます。 - -```ts -interface Author { - name: string - description?: string - github?: string - image?: - | { - type: 'svg' - name: string - } - | { - type: 'external-url' - url: string - } +- github : GitHub アカウントの ID + +Example: `src/content/authors/octocat.json` + +```json +{ + "name": "Octocat", + "description": "GitHubの猫です。", + "github": "octocat" } ``` -## タグ +### 著者のアイコン（任意） + +`src/content/authors`にJSONと同じファイル名の画像ファイルを置くことでアイコンを変更できます。ファイル形式はSVGまたはPNGです。例えばJSONが`octocat.json`の場合、アイコンは`octocat.svg`または`octocat.png`としてください。 + +なお、画像ファイルが存在しない場合はGitHubのアイコンが使用されます。 + +## タグの追加 `src/content/tags` に JSON ファイルを追加することで新しいタグを作ることができます。ファイル名は記事の `tags` で指定する際の値となるのでわかりやすい名前にすることをおすすめします。 + タグのスキーマは以下のとおりです。 `name` 以外のプロパティは省略可能です。 -- name : タグの表示名 +- name : タグの表示名（必須） - description : タグの説明 -- image : タグのアイコン - - `svg` は `src/assets/icons/blog` に入っているsvgファイルを指定できます。`name` には拡張子を除いたファイル名を指定してください。 - - `external-url` は外部の画像を指定できます。 - site : 公式サイト - url : 公式サイトのURL - text : リンクの表示名 (指定のない場合 `タグ名 - 公式サイト` となります) @@ -85,30 +82,25 @@ interface Author { - url : GitHubのリポジトリのURL - text : リンクの表示名 (指定のない場合 `タグ名 - GitHub` となります) -```ts -interface Tag { - name: string - description?: string - image?: - | { - type: 'svg' - name: string - } - | { - type: 'external-url' - url: string - } - site?: { - url: string - text?: string - } - document?: { - url: string - text?: string - } - github?: { - url: string - text?: string +Example: `src/content/tags/csharp.json` + +```json +{ + "name": "C#", + "description": "C#は、最新のタイプ セーフなオブジェクト指向のプログラミング言語です。 開発者は C# を使用することにより、.NET で稼働する、安全かつ堅牢な多くの種類のアプリケーションを構築できます。", + "site": { + "url": "https://dotnet.microsoft.com/ja-jp/learn/dotnet/what-is-dotnet" + }, + "document": { + "url": "https://learn.microsoft.com/ja-jp/dotnet/csharp/programming-guide/" + }, + "github": { + "url": "https://github.com/dotnet/runtime", + "text": ".NET Runtime - GitHub" } } ``` + +### タグのアイコン（任意） + +`src/content/tags`にJSONと同じファイル名の画像ファイルを置くことでアイコンを変更できます。ファイル形式はSVGまたはPNGです。例えばJSONが`csharp.json`の場合、アイコンは`csharp.svg`または`csharp.png`としてください。