ci(mdl): add markdown linter

This commit is contained in:
James Harris
2020-06-02 00:29:19 +01:00
parent 8e1929290d
commit ecf68cd91e
35 changed files with 662 additions and 498 deletions

View File

@ -27,13 +27,14 @@
本仓库中的源代码来自对纸质打印输出文件的手动数字化,所以会不小心引入一些拼写错误和其他差异。这些代码应该被修正以使其与原纸质打印输出文件内容保持一致:
* [阿波罗11号制导计算机AGC中指令模块打印输出][8]
* [阿波罗11号制导计算机AGC中登月模块打印输出][9]
- [阿波罗11号制导计算机AGC中指令模块打印输出][8]
- [阿波罗11号制导计算机AGC中登月模块打印输出][9]
## 有用的扩展
GitHub内建会支持AGC汇编语言语法。不幸的是你的代码编辑器不会但有些
AGC的语言扩展插件可以为下列的编辑器提供语法高亮显示支持
- [Atom][Atom]†
- [CodeBlocks][CodeBlocks]
- [Eclipse][Eclipse]
@ -59,30 +60,32 @@ AGC的语言扩展插件可以为下列的编辑器提供语法高亮显示支
[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
## 格式化
**注意**GitHub和上面列出的3个扩展插件会确保您自动使用正确的格式。
- 使用TAB进行缩进
- TAB宽度为8个字符
- 去掉末尾的空格
## 我该怎么检查?
## 我该怎么检查
原始的扫描打印输出文件与此存储库中的源码之间存在的差异,包括:
### 注释
- 转录代码中的注释应与扫描完全匹配
- 这可能涉及故意创建的拼写错误或删除/添加整个评论
### 换行
- 第1列带`R0000`的换行符应与扫描完全匹配。
- 第1列中带**__out__* `R0000` 的换行符应该只包含一个或2个连续空行。
- 如果有超过2个空行换行请删除额外的空白行换行。
- 第1列中带`R0000`的行不计入此。
- 在原始图片中这些是由一个未打印的数字分8列创建. A 2 处强制两个空格单个空白行A 3 强制三个空格双空行。值4-8是被定义但从未使用过。可在[#159][7]查看更多
例如以下内容:
```plain
R0819 SUBROUTINE TO SKIP...
R0820
@ -91,7 +94,9 @@ R0820
0821 LAMPTEST CS IMODES33
```
应该改为:
```plain
R0819 SUBROUTINE TO SKIP...
R0820
@ -101,18 +106,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.