brain-hackers_pepepper-mirror/wiki.brainux.org
1
0
Fork 0
mirror of https://github.com/brain-hackers/wiki.brainux.org synced 2024-12-22 12:10:06 +09:00
Code Issues Projects Releases Wiki Activity

Update How To Write

Browse Source
This commit is contained in:
Takumi Sueda 2022-01-12 03:45:55 +09:00
parent 1e02a89d86
commit 9c76ea9ddd
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
_posts/2021-12-04-meta-how-to-edit-wiki.md
View File

@ -142,7 +142,7 @@ Wiki の体裁に関するルールを列挙します。コミットの前に従
## 文体
基本的には、技術文書のルールと同一です。
基本的には、技術文書のルールと同一です。助詞の使いすぎや表記ゆれはtextlintでチェックできますが、機械的に検知できる範囲は限られているためよく心得ておいてください。
### 「ですます」と「だ・である」は統一する
@ -207,6 +207,7 @@ Linterによるチェック: **なし**
## Markdown
Markdown はリッチなレンダリングがなくとも読めるシンタックスが特徴です。これを念頭に置いて、以下のルールに従ってください。
一部はmarkdownlintによって違反を検知できます。ここにない細かなルールはmarkdownlintの指示に従ってください。
### 必ずプレビューして確認する