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

@ -26,9 +26,8 @@
[ZH_TW]:CONTRIBUTING.zh_tw.md
## 유용한 확장기능들
GitHub은 내장 에디터에서 AGC문법을 지원합니다.
그러나 불행하게도 대개 사용되는 에디터들은 그렇지 않습니다.
하지만 확장 기능이 지원되는 에디터들이 있습니다.
GitHub은 내장 에디터에서 AGC문법을 지원합니다. 그러나 불행하게도 대개 사용되는 에디터들은 그렇지 않습니다. 하지만 확장 기능이 지원되는 에디터들이 있습니다.
- [Atom][Atom]†
- [CodeBlocks][CodeBlocks]
@ -55,6 +54,7 @@ GitHub은 내장 에디터에서 AGC문법을 지원합니다.
[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
## 포매팅
**참고:** Github 내장 에디터와 위의 세 확장기능들은 이 문단에서 정의하는 포매팅을 자동으로 수행해줍니다.
- 탭 들여쓰기를 사용하십시오.
@ -62,11 +62,14 @@ GitHub은 내장 에디터에서 AGC문법을 지원합니다.
- 뒤에 불필요하게 붙는 공백 문자는 제거하시기 바랍니다.
## 확인해야 할 것들
### 주석
- 옮겨진 코드의 주석들은 스캔본과 일치해야 합니다.
- 의도적인 오타나 전체 주석을 삭제/추가하는 것과 관계가 있을 수 있습니다.
### 개행
- 1열에서 `R0000`로 개행되는 경우 스캔본과 일치해야 합니다.
- 1열에서 `R0000`*__없이__*  개행되는 경우 1~2개의 빈 줄이 있어야 합니다.
- 만약 3개 이상의 개행이 있는경우 초과분을 제거하십시오.
@ -76,6 +79,7 @@ GitHub은 내장 에디터에서 AGC문법을 지원합니다.
4-8의 값들은 정의되었지만 사용되지 않습니다. 자세한 내용은 [#159][7]를 참고하십시오.
예를 들어 이 코드는:
```plain
R0819 SUBROUTINE TO SKIP...
R0820
@ -84,7 +88,9 @@ R0820
0821 LAMPTEST CS IMODES33
```
이렇게 고쳐야 합니다:
```plain
R0819 SUBROUTINE TO SKIP...
R0820