Skip to content

Commit 40e5735

Browse files
azuazu
committed
chore(readme): add header
1 parent d8ebcd2 commit 40e5735

File tree

2 files changed

+64
-60
lines changed

2 files changed

+64
-60
lines changed

‎README.md‎

Lines changed: 46 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -28,116 +28,118 @@ textlint --preset ja-technical-writing README.md
2828

2929
## ルール一覧
3030

31-
- 1文の長さは90文字以下とする
32-
- https://github.com/azu/textlint-rule-sentence-length
31+
# 1文の長さは90文字以下とする
32+
https://github.com/azu/textlint-rule-sentence-length
3333

3434
"sentence-length": {
3535
max: 90
3636
},
3737
38-
- コンマは1文中に3つまで
39-
- https://github.com/azu/textlint-rule-max-comma
38+
# コンマは1文中に3つまで
39+
https://github.com/azu/textlint-rule-max-comma
4040

4141
"max-comma": {
4242
max: 3
4343
},
4444
45-
- 読点は1文中に3つまで
46-
- https://github.com/azu/textlint-rule-max-ten
45+
# 読点は1文中に3つまで
46+
https://github.com/azu/textlint-rule-max-ten
4747

4848
"max-ten": {
4949
max: 3
5050
},
51-
52-
- 連続できる最大の漢字長は5文字まで
53-
- 6文字以上の漢字は使用しない
54-
- https://github.com/azu/textlint-rule-max-kanji-continuous-len
51+
52+
# 連続できる最大の漢字長は5文字まで
53+
6文字以上の漢字は使用しない
54+
https://github.com/azu/textlint-rule-max-kanji-continuous-len
5555

5656
"max-kanji-continuous-len": {
5757
max: 5
5858
},
5959
60-
- 数量を表現し、数を数えられるものは算用数字を使用します。
61-
- 任意の数に置き換えても通用する語句がこれに該当します。序数詞（「第～回」「～番目」「～回目」）も算用数字を使います。
62-
- 慣用的表現、熟語、概数、固有名詞、副詞など、漢数字を使用することが一般的な語句では漢数字を使います。
63-
- https://github.com/azu/textlint-rule-preset-JTF-style
64-
- https://www.jtf.jp/jp/style_guide/styleguide_top.html
60+
# 漢数字と算用数字を使い分けます
61+
数量を表現し、数を数えられるものは算用数字を使用します。
62+
任意の数に置き換えても通用する語句がこれに該当します。序数詞（「第～回」「～番目」「～回目」）も算用数字を使います。
63+
慣用的表現、熟語、概数、固有名詞、副詞など、漢数字を使用することが一般的な語句では漢数字を使います。
64+
https://github.com/azu/textlint-rule-preset-JTF-style
65+
https://www.jtf.jp/jp/style_guide/styleguide_top.html
6566

6667
"arabic-kanji-numbers": true,
67-
68-
- 「ですます調」、「である調」を統一します
69-
- 見出しは自動
70-
- 本文はですます調
71-
- 箇条書きはである調
72-
- https://github.com/azu/textlint-rule-no-mix-dearu-desumasu
68+
69+
# 「ですます調」、「である調」を統一します
70+
見出しは自動
71+
本文はですます調
72+
箇条書きはである調
73+
https://github.com/azu/textlint-rule-no-mix-dearu-desumasu
7374

7475
"no-mix-dearu-desumasu": {
7576
"preferInHeader": "",
7677
"preferInBody": "ですます",
7778
"preferInList": "である",
7879
"strict": true
7980
},
80-
81-
- 文末には句点記号として。を使います
82-
- https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period
81+
82+
# 文末の句点記号として「。」を使います
83+
https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period
8384

8485
"ja-no-mixed-period": {
8586
"periodMark": "。"
8687
},
8788
88-
- 二重否定は使用しない
89-
- https://github.com/azu/textlint-rule-no-double-negative-ja
89+
# 二重否定は使用しない
90+
https://github.com/azu/textlint-rule-no-double-negative-ja
9091

9192
"no-double-negative-ja": true,
9293
93-
- ら抜き言葉を使用しない
94-
- https://github.com/azu/textlint-rule-no-dropping-the-ra
94+
# ら抜き言葉を使用しない
95+
https://github.com/azu/textlint-rule-no-dropping-the-ra
9596

9697
"no-dropping-the-ra": true,
9798
98-
- 同じ表現から文を開始しすぎない
99-
- https://github.com/azu/textlint-rule-no-start-duplicated-conjunction
99+
# 同じ表現から文を開始しすぎない
100+
https://github.com/azu/textlint-rule-no-start-duplicated-conjunction
100101

101102
"no-start-duplicated-conjunction": {
102103
"interval": 2
103104
},
104105
105-
- 同じ接続詞を連続して使用しない
106-
- https://github.com/takahashim/textlint-rule-no-doubled-conjunction
106+
# 同じ接続詞を連続して使用しない
107+
https://github.com/takahashim/textlint-rule-no-doubled-conjunction
107108

108109
"no-doubled-conjunction": true,
109110
110-
- 同じ助詞を連続して使用しない
111+
# 同じ助詞を連続して使用しない
111112

112113
"no-doubled-joshi": {
113114
"min_interval": 1
114115
},
115116
116-
- 感嘆符!！、疑問符?？を使用しない
117-
- https://github.com/azu/textlint-rule-no-exclamation-question-mark
117+
# 感嘆符!！、疑問符?？を使用しない
118+
https://github.com/azu/textlint-rule-no-exclamation-question-mark
118119

119120
"no-exclamation-question-mark": true,
120121
121-
- 半角カナを使用しない
122-
- https://github.com/azu/textlint-rule-no-hankaku-kana
122+
# 半角カナを使用しない
123+
https://github.com/azu/textlint-rule-no-hankaku-kana
123124

124125
"no-hankaku-kana": true,
125126
126-
- 〜かもしれない 等の弱い日本語表現の利用を使用しない
127-
- https://github.com/textlint-ja/textlint-rule-ja-no-weak-phrase
127+
# 弱い日本語表現の利用を使用しない
128+
〜かもしれない 等の弱い表現を使用しない
129+
https://github.com/textlint-ja/textlint-rule-ja-no-weak-phrase
128130

129131
"ja-no-weak-phrase": true,
130132
131-
- 同一の単語を間違えて連続しているのをチェックする
132-
- https://github.com/textlint-ja/textlint-rule-ja-no-successive-word
133+
# 同一の単語を間違えて連続しているのをチェックする
134+
https://github.com/textlint-ja/textlint-rule-ja-no-successive-word
133135

134136
"ja-no-successive-word": true,
135137
136-
- よくある日本語の誤用をチェックする
137-
- https://github.com/textlint-ja/textlint-rule-ja-no-abusage
138+
# よくある日本語の誤用をチェックする
139+
https://github.com/textlint-ja/textlint-rule-ja-no-abusage
138140

139141
"ja-no-abusage": true
140-
142+
141143
## Changelog
142144

143145
See [Releases page](https://github.com/textlint-ja/textlint-rule-preset-ja-technical-writing/releases).

‎lib/textlint-rule-preset-ja-technical-writing.js‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,34 +22,35 @@ module.exports = {
2222
"ja-no-abusage": require("textlint-rule-ja-no-abusage")
2323
},
2424
rulesConfig: {
25-
// 1文の長さは90文字以下とする
25+
// # 1文の長さは90文字以下とする
2626
// https://github.com/azu/textlint-rule-sentence-length
2727
"sentence-length": {
2828
max: 90
2929
},
30-
// コンマは1文中に3つまで
30+
// # コンマは1文中に3つまで
3131
// https://github.com/azu/textlint-rule-max-comma
3232
"max-comma": {
3333
max: 3
3434
},
35-
// 読点は1文中に3つまで
35+
// # 読点は1文中に3つまで
3636
// https://github.com/azu/textlint-rule-max-ten
3737
"max-ten": {
3838
max: 3
3939
},
40-
// 連続できる最大の漢字長は5文字まで
40+
// # 連続できる最大の漢字長は5文字まで
4141
// 6文字以上の漢字は使用しない
4242
// https://github.com/azu/textlint-rule-max-kanji-continuous-len
4343
"max-kanji-continuous-len": {
4444
max: 5
4545
},
46+
// # 漢数字と算用数字を使い分けます
4647
// 数量を表現し、数を数えられるものは算用数字を使用します。
4748
// 任意の数に置き換えても通用する語句がこれに該当します。序数詞（「第～回」「～番目」「～回目」）も算用数字を使います。
4849
// 慣用的表現、熟語、概数、固有名詞、副詞など、漢数字を使用することが一般的な語句では漢数字を使います。
4950
// https://github.com/azu/textlint-rule-preset-JTF-style
5051
// https://www.jtf.jp/jp/style_guide/styleguide_top.html
5152
"arabic-kanji-numbers": true,
52-
// 「ですます調」、「である調」を統一します
53+
// # 「ですます調」、「である調」を統一します
5354
// 見出しは自動
5455
// 本文はですます調
5556
// 箇条書きはである調
@@ -60,42 +61,43 @@ module.exports = {
6061
"preferInList": "である",
6162
"strict": true
6263
},
63-
// 文末には句点記号として。を使います
64+
// # 文末の句点記号として「。」を使います
6465
// https://github.com/textlint-ja/textlint-rule-ja-no-mixed-period
6566
"ja-no-mixed-period": {
6667
"periodMark": "。"
6768
},
68-
// 二重否定は使用しない
69+
// # 二重否定は使用しない
6970
// https://github.com/azu/textlint-rule-no-double-negative-ja
7071
"no-double-negative-ja": true,
71-
// ら抜き言葉を使用しない
72+
// # ら抜き言葉を使用しない
7273
// https://github.com/azu/textlint-rule-no-dropping-the-ra
7374
"no-dropping-the-ra": true,
74-
// 同じ表現から文を開始しすぎない
75+
// # 同じ表現から文を開始しすぎない
7576
// https://github.com/azu/textlint-rule-no-start-duplicated-conjunction
7677
"no-start-duplicated-conjunction": {
7778
"interval": 2
7879
},
79-
// 同じ接続詞を連続して使用しない
80+
// # 同じ接続詞を連続して使用しない
8081
// https://github.com/takahashim/textlint-rule-no-doubled-conjunction
8182
"no-doubled-conjunction": true,
82-
// 同じ助詞を連続して使用しない
83+
// # 同じ助詞を連続して使用しない
8384
"no-doubled-joshi": {
8485
"min_interval": 1
8586
},
86-
// 感嘆符!！、疑問符?？を使用しない
87+
// # 感嘆符!！、疑問符?？を使用しない
8788
// https://github.com/azu/textlint-rule-no-exclamation-question-mark
8889
"no-exclamation-question-mark": true,
89-
// 半角カナを使用しない
90+
// # 半角カナを使用しない
9091
// https://github.com/azu/textlint-rule-no-hankaku-kana
9192
"no-hankaku-kana": true,
92-
// 〜かもしれない 等の弱い日本語表現の利用を使用しない
93+
// # 弱い日本語表現の利用を使用しない
94+
// 〜かもしれない 等の弱い表現を使用しない
9395
// https://github.com/textlint-ja/textlint-rule-ja-no-weak-phrase
9496
"ja-no-weak-phrase": true,
95-
// 同一の単語を間違えて連続しているのをチェックする
97+
// # 同一の単語を間違えて連続しているのをチェックする
9698
// https://github.com/textlint-ja/textlint-rule-ja-no-successive-word
9799
"ja-no-successive-word": true,
98-
// よくある日本語の誤用をチェックする
100+
// # よくある日本語の誤用をチェックする
99101
// https://github.com/textlint-ja/textlint-rule-ja-no-abusage
100102
"ja-no-abusage": true
101103
}

0 commit comments

Comments
 (0)