Auth Vault 使い方ガイド

Auth Vaultは、GitHubリポジトリをCMSとして活用するブログプラットフォームです。
あなたのGitHubリポジトリにMarkdownファイルを配置することで、記事を執筆・管理できます。

はじめる前に

Auth Vaultで記事を投稿するには、以下の準備が必要です。

1. Auth Vaultアカウント - ログインしてアカウントを作成します
2. GitHubアカウント - 記事の管理にGitHubを使用します
3. GitHubリポジトリの連携 - 記事を管理するリポジトリを連携します

アカウントの作成とGitHub連携

1. ログイン

トップページ右上の「ログイン」ボタンをクリックし、認証を行います。

2. リポジトリの連携

ログイン後、ダッシュボードの設定画面からGitHubリポジトリを連携します。

1. 画面左のメニューから「設定」を選択
2. 「GitHub リポジトリ連携」セクションで「リポジトリを連携」をクリック
3. GitHub Appのインストール画面が表示されるので、連携したいリポジトリを選択
4. インストールを許可して完了

記事の書き方

ファイルの配置

記事はリポジトリの articles ディレクトリに、画像は images ディレクトリに配置します。

your-repository/
├── articles/
│   ├── my-first-article.md
│   └── authentication-guide.md
└── images/
    ├── screenshot-1.png
    └── diagram.png

ファイル名

ファイル名がそのまま記事のURL（スラッグ）になります。

• 使用可能な文字: 半角英数字 と ハイフン（-）
• 例: my-first-article.md → /あなたのユーザー名/articles/my-first-article

フロントマター

各記事ファイルの先頭に、YAML形式のフロントマターを記述します。

---
title: 記事のタイトル
published: true
targetCategories: [authentication, security]
topics: [auth0, oauth, セキュリティ]
---

ここから本文を書きます...

targetCategories について

targetCategories は記事の対象分野を示す必須項目です。以下の値から1つ以上を配列で指定してください。

# 例：認証と認可に関する記事
targetCategories: [authentication, authorization]

Markdown記法

Auth Vaultは内部で Zenn のMarkdown 変換ライブラリであるzenn-markdown-htmlを使用しています。
そのため、基本的にZennと同じ記法が使用できます。
基本的なMarkdown記法に加え、Zenn独自の拡張記法にも対応しています。
以下例です。

見出し

記法：

## 見出し2
### 見出し3
#### 見出し4

表示：

見出し2

見出し3

見出し4

テキストの装飾

記法：

**太字テキスト**
*イタリック*
~~打ち消し線~~

表示：

太字テキスト
イタリック
打ち消し線

リスト

記法：

- リスト項目1
- リスト項目2
  - ネストしたリスト

1. 番号付きリスト1
2. 番号付きリスト2

表示：

• リスト項目1
• リスト項目2
  • ネストしたリスト

1. 番号付きリスト1
2. 番号付きリスト2

リンク

記法：

[リンクテキスト](https://example.com)

表示：

リンクテキスト

引用

記法：

> これは引用文です。
> 複数行にまたがることもできます。

表示：

これは引用文です。
複数行にまたがることもできます。

コードブロック

インラインコードは `code` で囲みます。表示：code

複数行のコードブロックの記法：

```javascript
function greet(name) {
  console.log(`Hello, ${name}!`);
}
```

表示：

function greet(name) {
  console.log(`Hello, ${name}!`);
}

テーブル

記法：

| 列1 | 列2 | 列3 |
|-----|-----|-----|
| A   | B   | C   |
| D   | E   | F   |

表示：

メッセージボックス

情報や警告を目立たせるためのメッセージボックスが使用できます。

記法：

:::message
通常のメッセージです。補足情報などに使用します。
:::

:::message alert
警告メッセージです。注意が必要な情報に使用します。
:::

表示：

アコーディオン（トグル）

クリックで展開できるセクションを作成できます。

記法：

:::details タイトル
ここに折りたたまれた内容を書きます。
クリックすると展開されます。
:::

表示：

画像の追加

画像ファイルの配置

画像は articles ディレクトリと同階層の images フォルダに配置します。

your-repository/
├── articles/
│   └── my-article.md
└── images/
    └── screenshot.png

画像の参照

Markdownファイル内で相対パスを使って画像を参照します。

![代替テキスト](./images/screenshot.png)

画像の制限

埋め込みコンテンツ

リンクカード

URLを単独の行に記述すると、自動的にリンクカードとして表示されます。

https://example.com/article

https://web.maronn-room.com

記事の投稿

投稿の流れ

1. 記事ファイルを作成し、published: true を設定
2. GitHubリポジトリの main ブランチにプッシュ
3. 自動的に審査キューに追加される
4. 管理者による審査
5. 承認されると公開

# 記事を作成してプッシュ
git add articles/my-new-article.md
git commit -m "Add new article: my-new-article"
git push origin main

記事の更新

公開済みの記事を更新する場合も、同様にファイルを編集してプッシュします。

1. 記事ファイルを編集
2. main ブランチにプッシュ
3. 更新内容が再度審査キューに追加される
4. 承認されると更新が反映

審査について

Auth Vaultでは、すべての記事が公開前に審査を受けます。
これは、プラットフォームの品質と安全性を維持するためです。

審査の基準

以下のプロンプトに基づいた審査と、適宜管理者による審査が行われます。

https://web.maronn-room.com/guide/review-prompt

承認される記事:

• オリジナルのコンテンツである
• 適切な日本語（または英語）で書かれている
• 他者を攻撃・誹謗中傷する内容がない

却下される可能性がある記事:

• スパムや宣伝のみを目的とした内容
• 著作権を侵害するコンテンツ
• 差別的・攻撃的な表現
• 個人情報を含む内容
• 技術的に明らかに誤った情報

審査結果の確認

審査結果は以下の方法で確認できます。

1. ダッシュボード - 左メニューの「記事一覧」でステータスを確認
2. 通知 - 審査完了時に通知が届きます。メールでも審査結果を通知します。

ステータスの種類

記事の削除

公開済みの記事を削除したい場合は、ダッシュボードの記事一覧から削除操作を行ってください。

Q&A

Q: 複数のリポジトリを連携できますか？

Auth Vaultは1つのリポジトリのみの連携を想定しています。
複数のリポジトリを連携した場合の動作は保証されません。
連携先を変更したい場合は、設定画面から現在の連携を解除してから、新しいリポジトリを連携してください。

Q: 下書きはどこに保存されますか？

published: false の記事はGitHubリポジトリ上にのみ存在し、Auth Vaultには同期されません。完成したら published: true に変更してプッシュしてください。

Q: 審査にはどのくらい時間がかかりますか？

審査時間は状況により異なります。
通常は数日以内に審査が完了しますが、混雑状況によっては多少お時間をいただく場合があります。

Q: 却下された記事は再投稿できますか？

はい、却下理由を確認し、内容を修正してから再度プッシュしてください。
修正された記事は再審査の対象となります。

Q: 過去の記事を非公開にできますか？

公開中の記事を非公開にするには、ダッシュボードから記事を削除してください。published: false に変更してプッシュしても、すでに公開された記事は自動的に非公開にはなりません。

Q: 広告記事は投稿可能ですか？

可能です。
ただし、認証・認可・セキュリティに関する内容として適切であることが前提です。
内容が知見を深めるものであれば、広告記事であっても掲載させていただきます。

ご不明な点がございましたら、お問い合わせフォームよりお問い合わせください。