-
Notifications
You must be signed in to change notification settings - Fork 1
/
a5doc.yml
104 lines (93 loc) · 2.95 KB
/
a5doc.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
projectCode: a5doc-example
projectName: &projectName A5顧客管理システム
# テーブルのカラムについて、テーブル間で同名のカラムについて、
# 型と桁数が一致していることチェックする
columnNameConsistencyCheck: true;
# ドキュメントのルートディレクトリ
docroot: ./example/docs
# ドキュメントのスタイル
## wiki: wikiでドキュメントを参照する用
## md: 通常のgitリポジトリでドキュメントを参照する用
docstyle: md
# _Sidebar作成
sidebar:
# ドキュメント名(目次ページのタイトル)
title: *projectName
# 対象ドキュメント収集モジュール
indexer: chapterIndexer
# chapter定義型のドキュメント収集モジュール
chapters:
- title: Home
src: home.md
- title: 設計
chapters:
- title: ER図
dir: 設計/テーブル定義
src: "**/ER図*.md"
collapse: true
- title: テーブル定義
dir: 設計/テーブル定義
src:
- "**/*.md"
- "!**/ER図*.md"
collapse: false
- title: APIインターフェース
dir: 設計/API
src:
- "**/*.md"
collapse: false
# PDF作成
gitbook:
indexer: chapterIndexer
$chaptersRef: pdfChapters
pdfChapters:
- title: 設計
dir: 設計
src: "**/*.md"
table:
src:
- ./example/.a5doc/table/**/*.yml
tableMdDir: ./example/docs/設計/テーブル定義
erd:
- id: ER-001
docTitle: ER図(全体)
description: システム全体のER図
path: ./example/docs/設計/テーブル定義/ER図-全体.md
# 表示するテキスト形式
# logical=論理名 | physical=物理名 | both=物理名+論理名
labelType: logical
# 作図するテーブルを指定
entityPatterns:
# id=テーブルIDの正規表現
# columnType=表示するカラムタイプ
# all=全カラムを表示 | no=カラムなし | pk=PKのみ | pk+uk=PKとUKのみ
- id: .*
columnType: no
- id: ER-002
docTitle: ER図(顧客)
description: 顧客を中心にしたER図
path: ./example/docs/設計/テーブル定義/ER図-顧客.md
labelType: physical
entityPatterns:
- id: m_account.*
columnType: pk
- id: m_customer
columnType: all
- id: ER-003
docTitle: ER図(アカウント)
description: アカウント
path: ./example/docs/設計/テーブル定義/ER図-アカウント.md
labelType: both
entityPatterns:
- id: m_account.*
columnType: all
swagger:
src:
- 設計/API/**/*.yml
- "!設計/API/swagger.yml"
- "!設計/API/common.yml"
dst: 設計/API
common: 設計/API/common.yml
merge:
- 設計/API/swagger.yml
- 設計/API/swagger.json