ci(mdl): add markdown linter
This commit is contained in:
@ -27,12 +27,13 @@
|
||||
|
||||
這個倉庫的原始碼,是透過列印出的紙本輸出,予以手動數位化。所以可能會不小心出現錯字和其他出入。程式碼應當修正到與紙本掃描的輸出一致:
|
||||
|
||||
* [AGC printouts for Comanche][8]
|
||||
* [AGC printouts for Luminary][9]
|
||||
- [AGC printouts for Comanche][8]
|
||||
- [AGC printouts for Luminary][9]
|
||||
|
||||
## 實用套件
|
||||
|
||||
GitHub 內建 AGC 組語語法支援,但你的編輯器本身並沒有。不過,某些編輯器有提供 AGC 語法突顯的語言套件:
|
||||
|
||||
- [Atom][Atom]†
|
||||
- [CodeBlocks][CodeBlocks]
|
||||
- [Eclipse][Eclipse]
|
||||
@ -58,6 +59,7 @@ GitHub 內建 AGC 組語語法支援,但你的編輯器本身並沒有。不
|
||||
[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
|
||||
|
||||
## 格式化
|
||||
|
||||
**注意:**GitHub 與上面列出的套件,會自動確保您使用正確的格式。
|
||||
|
||||
- 用 tab 縮排
|
||||
@ -65,13 +67,16 @@ GitHub 內建 AGC 組語語法支援,但你的編輯器本身並沒有。不
|
||||
- 去除底部空白
|
||||
|
||||
## 如何檢查?
|
||||
|
||||
掃描與倉庫原始碼的差異會包括:
|
||||
|
||||
### 註解
|
||||
|
||||
- 抄寫的註解要和掃描一模一樣。
|
||||
- 這包括刻意的拼寫錯誤、或是刪除/增加整個註解。
|
||||
|
||||
### 換行
|
||||
|
||||
- 在第一列(column 1)*有著* `R0000` 的換行,要和掃描一模一樣。
|
||||
- 在第一列*沒有* `R0000` 的換行,在一行(row)只能留有一到兩個空白行。
|
||||
- 如果空白行超過兩個,請刪去額外的空白行。
|
||||
@ -79,6 +84,7 @@ GitHub 內建 AGC 組語語法支援,但你的編輯器本身並沒有。不
|
||||
- 在原始圖片中,這些都是由第八列(column 8)的未列印數字所產生。2 強制用兩個(也就是單一空白行)、3 強制用三個(也就是雙空行)、4-8 有定義,但從未使用過。請參閱 [#159][7] 的詳細訊息。
|
||||
|
||||
例如以下程式:
|
||||
|
||||
```plain
|
||||
R0819 SUBROUTINE TO SKIP...
|
||||
R0820
|
||||
@ -87,7 +93,9 @@ R0820
|
||||
|
||||
0821 LAMPTEST CS IMODES33
|
||||
```
|
||||
|
||||
要改寫成:
|
||||
|
||||
```plain
|
||||
R0819 SUBROUTINE TO SKIP...
|
||||
R0820
|
||||
@ -97,17 +105,21 @@ R0820
|
||||
```
|
||||
|
||||
### 空白
|
||||
|
||||
- 在字元內,兩個單字之間的空白必須遵照以下慣例(請參閱 [#316][10] 的討論):
|
||||
- 單字間空一格。
|
||||
- 句子間空兩格。
|
||||
- 縮排間空三格。
|
||||
|
||||
例如以下程式:
|
||||
|
||||
```plain
|
||||
1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
|
||||
GARPLY, WALDO.
|
||||
```
|
||||
|
||||
要改寫成:
|
||||
|
||||
```plain
|
||||
1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
|
||||
GARPLY, WALDO.
|
||||
|
Reference in New Issue
Block a user