GitNovel 利用ガイド
GitNovelで小説を公開するための手順とデータ形式をご紹介します
基本的な使い方
1
リポジトリ構造を準備
Gitリポジトリに小説のメタデータファイル(novel.yaml)と本文ファイル(txt)を配置します。フラット構造でシンプルに管理できます。
my-novel/ ├── novel.yaml # 作品メタデータ + エピソード一覧 ├── 001.txt # 第1話 本文 ├── 002.txt # 第2話 本文 ├── 003.txt # 第3話 本文 └── ...
サブディレクトリは不要です。ファイル名は連番(001.txt, 002.txt, ...)を推奨します。
2
novel.yaml を作成
作品の基本情報とエピソード一覧をYAML形式で定義します。
# 作品情報
title: あなたの小説タイトル
author: 著者名
description: |
小説のあらすじを記載します。
複数行で書くことができます。
# オプション項目
genre: ファンタジー
tags:
- 異世界
- 冒険
status: 連載中 # 連載中 / 完結済
# エピソード一覧
episodes:
- title: 第1話 始まりの物語
filename: 001.txt
publishDate: 2026-01-01
- title: 第2話 新たな展開
filename: 002.txt
publishDate: 2026-01-08 3
本文を執筆
各エピソードはプレーンテキスト形式で記述します。タイトルは novel.yaml で管理するため、本文ファイルには含めません。
王都の城門が見えた時、旅人は思わず足を止めた。 長い旅路の果てにたどり着いたその場所は、|紅蓮《ぐれん》の夕焼けに照らされていた。 「ようやく……着いたのか」 彼は深く息を吐き、再び歩き始めた。
4
GitNovelに登録
管理画面からリポジトリURLを登録し、同期を実行します。リポジトリへの更新は定期的に自動同期されます。
現在は公開リポジトリのみ対応しています。
データ形式ガイド
novel.yaml の項目
| 項目 | 必須 | 説明 |
|---|---|---|
| title | 必須 | 作品タイトル(255文字以内) |
| author | 必須 | 作者名(255文字以内) |
| description | 必須 | あらすじ(2000文字以内) |
| episodes | 必須 | エピソード一覧(1つ以上) |
| genre | 任意 | ジャンル |
| tags | 任意 | タグリスト |
| status | 任意 | 連載状態(「連載中」/「完結済」) |
装飾記法
本文では「小説家になろう」互換の装飾記法が使えます。他の小説投稿サイトにそのままコピペできます。
ルビ
|親文字《ルビ》
使用例:
|紅蓮《ぐれん》の炎が燃え上がった。 吾輩は|猫《ねこ》である。
縦棒(|)は全角、山括弧(《》)は二重山括弧を使ってください。
傍点(強調)
《《強調したい文字》》
使用例:
その姿は《《荘厳》》だった。
本文の基本ルール
1.プレーンテキスト形式で記述(HTMLやMarkdownではありません)
2.文字コードは UTF-8
3.改行コードは LF(Unix形式)
4.タイトルは本文に含めない(novel.yaml で管理)
他サイトとの互換性
GitNovelのデータ形式は、他の小説投稿サイトとの互換性を重視しています。本文をそのままコピー&ペーストで他サイトに投稿できます。
コピペ運用フロー
GitNovel
→novel.yaml からタイトルをコピー → 投稿先のタイトル欄に貼り付けGitNovel
→001.txt から本文をコピー → 投稿先の本文欄に貼り付け| 記法 | GitNovel | なろう | カクヨム |
|---|---|---|---|
| |親《ルビ》 | 対応 | 対応 | 対応 |
| 《《傍点》》 | 対応 | 一部 | 対応 |
ユースケース
個人執筆での活用
- •執筆の全履歴が残るため、推敲過程を振り返れる
- •タグ機能で「第1巻完成版」など版管理が可能
- •ブランチで別展開を試し、気に入ったものを採用
- •自動バックアップで原稿紛失の心配なし
共同執筆プロジェクト
- •各執筆者が独立して作業し、Pull Requestで統合
- •レビュー機能で品質を担保しながら進行
- •誰がいつ何を書いたか明確に記録
- •翻訳プロジェクトでの原文・訳文管理も容易
トラブルシューティング
同期しても小説が表示されない
- •novel.yaml が正しいYAML形式か確認してください
- •必須項目(title, author, description, episodes)がすべて記載されているか確認してください
- •episodes の filename で指定したファイルがリポジトリに存在するか確認してください
ルビが正しく表示されない
- •縦棒が全角(|)になっているか確認してください。半角パイプ(|)は使えません
- •山括弧が二重山括弧(《》)か確認してください
エピソードの順番がおかしい
- •novel.yaml の episodes の記載順がそのまま表示順になります。並び順を確認してください
文字化けする
- •ファイルの文字コードがUTF-8になっているか確認してください
- •改行コードがLF(Unix形式)か確認してください。Windowsの場合、Gitの設定で自動変換が有効か確認してください
さあ、GitNovelで新しい執筆体験を始めましょう