ci(mdl): add markdown linter

WebLeach · Jun 1, 2020 · ecf68cd · ecf68cd
1 parent 8e19292
commit ecf68cd
Show file tree

Hide file tree

Showing 35 changed files with 619 additions and 455 deletions.
diff --git a/.github/workflows/markdownlint.yaml b/.github/workflows/markdownlint.yaml
@@ -0,0 +1,10 @@
+name: markdownlint
+on: [push, pull_request]
+jobs:
+  delivery:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@master
+    - name: Run mdl (with rules)
+      uses: wopian/markdownlint@master
diff --git a/CONTRIBUTING.ar.md b/CONTRIBUTING.ar.md
@@ -29,12 +29,13 @@
 
 تم ترقيم الكود المصدري في هذا المستودع يدويًا من مطبوعات ورقية، لذلك تم إدخال أخطاء مطبعية وما شابه بطريق الخطأ. يجب تعديل الكود ليكون متوافقًا مع المطبوعات الممسوحة:
 
-* [مطبوعات AGC لComanche][8]
-* [مطبوعات AGC لLuminary][9]
+- [مطبوعات AGC لComanche][8]
+- [مطبوعات AGC لLuminary][9]
 
 ## ملحقات مفيدة
 
 يحتوي GitHub على دعم للغة تجميع AGC المضمنة. للاسف، لن يدعمه محرر الكود الخاص بك، ولكن هناك ملحقات توفر دعم للغة AGC من المحررين التاليين:
+
 - [Atom][Atom]†
 - [CodeBlocks][CodeBlocks]
 - [Eclipse][Eclipse]
@@ -48,39 +49,34 @@
 
 † يدعم التنسيق الآلي
 
-[Atom]:https://github.com/Alhadis/language-agc
-[CodeBlocks]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/CodeBlocks
-[Eclipse]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/Eclipse
-[Kate]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/Kate
-[ProgrammersNotepad]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/ProgrammersNotepad
-[Sublime Text]:https://github.com/jimlawton/AGC-Assembly
-[TextPad]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/TextPad
-[Vim]:https://github.com/wsdjeg/vim-assembly
-[VisualStudioCode]:https://github.com/wopian/agc-assembly
-[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
-
 ## التنسيق
+
 **ملاحظة:**  سيضمن GitHub والإضافات الثلاثة المذكورة أعلاه أنك تستخدم التنسيق الصحيح تلقائيًا.
 
 - استخدام علامة التبويب للمسافة البادئة.
 - استخدم العرض 8 لعلامة التبويب
 - تقليم الفراغات التابعة
 
 ## عما أفحص؟
+
 أي تباينات بين الممسوحات والكود المصدري في هذا المستودع، بما في ذلك:
 
 ### التعليقات
+
 - يجب أن تتطابق التعليقات في الكود المنسوخ مع الممسوحات بالضبط
   - قد يتضمن ذلك إنشاء خطأ مطبعي متعمد أو إزالة أو إضافة تعليق بأكمله.
 
 ### فواصل الأسطر
+
 - على فواصل الأسطر التي *تحتوي على* `R0000` في العمود 1 التطابق مع الممسوحات بالضبط.
 - على فواصل الأسطر التي __لا__ *تحتوي على* `R0000` في العمود 1 أن تتكون من سطر فارغ واحد أو إثنين متتاليين.
   - إذا تتالى أكثر من سطرين فارغين، جرد الأسطر الإضافية.
     - لا يتم إعتبار الأسطر التي تحتوي على `R0000` في العمود 1 في هذا.
   - في المصدر، تم إنشاء هذه الفواصل السطرية من خلال رقم غير مطبوع في العمود 8. وجود الرقم 2 هناك فرض فراغ مزدوج (سطر فارغ واحد) ووجود الرقم 3 فرض مساحة ثلاثية (سطران فارغان). تم تعريف القيم 4-8 ولكن لم تستخدم قط. اقرأ المزيد عنها في [#159][7]
 
 مثلاً، ما يلي:
+</div>
+
 ```plain
 R0819   SUBROUTINE TO SKIP...
 R0820
@@ -89,7 +85,11 @@ R0820
 
  0821   LAMPTEST  CS  IMODES33
 ```
+
+<div dir="RTL">
 يجب أن يصبح:
+</div>
+
 ```plain
 R0819   SUBROUTINE TO SKIP...
 R0820
@@ -98,27 +98,40 @@ R0820
  0820   LAMPTEST  CS  IMODES33
 ```
 
+<div dir="RTL">
+
 ### الفراغات
+
 - يجب أن تحترم الفراغات بين الحروف في سلاسل الاصطلاحية على حسب العرف التالي (راجع النقاش في [#316][10]):
   - فراغ واحد للكلمات الجديدة.
   - فراغان للجمل الجديدة.
   - ثلاث فراغات للمسافات البادئة.
 
 مثلاً، ما يلي:
+</div>
+
 ```plain
 	1)  FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
 	GARPLY, WALDO.
 ```
+
+<div dir="RTL">
 يجب أن يصبح:
+</div>
+
 ```plain
 	1) FOO BAR BAZ QUX QUUX QUUZ.  CORGE, GRAULT,
 	   GARPLY, WALDO.
 ```
 
+<div dir="RTL">
+
 ## ملاحظة
 
 قبل فتح طلبات السحب، يرجى التأكد من أن تغييراتك تتفق مع الممسوحات!
 
+</div>
+
 [0]:https://github.com/chrislgarry/Apollo-11/pull/new/master
 [1]:http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/
 [2]:http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/
@@ -127,4 +140,14 @@ R0820
 [8]:http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/
 [9]:http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/
 [10]:https://github.com/chrislgarry/Apollo-11/pull/316#pullrequestreview-102892741
-</div>
+
+[Atom]:https://github.com/Alhadis/language-agc
+[CodeBlocks]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/CodeBlocks
+[Eclipse]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/Eclipse
+[Kate]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/Kate
+[ProgrammersNotepad]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/ProgrammersNotepad
+[Sublime Text]:https://github.com/jimlawton/AGC-Assembly
+[TextPad]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/TextPad
+[Vim]:https://github.com/wsdjeg/vim-assembly
+[VisualStudioCode]:https://github.com/wopian/agc-assembly
+[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
diff --git a/CONTRIBUTING.de.md b/CONTRIBUTING.de.md
@@ -25,14 +25,15 @@
 [ZH_CN]:CONTRIBUTING.zh_cn.md
 [ZH_TW]:CONTRIBUTING.zh_tw.md
 
-Der Quellcode in diesem repository wurde manuell digitalisiert, also sind jegliche schriftliche Fehler und Ungereimtheiten aus versehen hinzugefügt worden. Der Code soll Modifiziert werden so dass er mit den Vorlagen übereinstimmt. 
+Der Quellcode in diesem repository wurde manuell digitalisiert, also sind jegliche schriftliche Fehler und Ungereimtheiten aus versehen hinzugefügt worden. Der Code soll Modifiziert werden so dass er mit den Vorlagen übereinstimmt.
 
-* [AGC printouts for Comanche][8]
-* [AGC printouts for Luminary][9]
+- [AGC printouts for Comanche][8]
+- [AGC printouts for Luminary][9]
 
 ## Nützliche Erweiterungen
 
-GitHub hat eine Integrierte Unterstützung für AGC assembly. Dasselbe gilt für ihren Code Editor nicht, dennoch gibt es AGC Erweiterungen die Syntax highlighting für die folgenden Editors zur Verfügung stellen: 
+GitHub hat eine Integrierte Unterstützung für AGC assembly. Dasselbe gilt für ihren Code Editor nicht, dennoch gibt es AGC Erweiterungen die Syntax highlighting für die folgenden Editors zur Verfügung stellen:
+
 - [Atom][Atom]†
 - [CodeBlocks][CodeBlocks]
 - [Eclipse][Eclipse]
@@ -44,7 +45,7 @@ GitHub hat eine Integrierte Unterstützung für AGC assembly. Dasselbe gilt für
 - [Visual Studio Code][VisualStudioCode]†
 - [jEdit][jEdit]
 
-† Unterstützen Automatisches Formatieren  
+† Unterstützen Automatisches Formatieren
 
 [Atom]:https://github.com/Alhadis/language-agc
 [CodeBlocks]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/CodeBlocks
@@ -57,28 +58,33 @@ GitHub hat eine Integrierte Unterstützung für AGC assembly. Dasselbe gilt für
 [VisualStudioCode]:https://github.com/wopian/agc-assembly
 [jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
 
-## Formatierung  
+## Formatierung
+
 **Anmerkung:** GitHub und die oben erwähnten Erweiterungen werden automatisch sicherstellen dass sie die Korrekte Formatierung einhalten.
 
 - benutze tab indentation
 - benutze tab width von 8
-- entferne nachlaufende leerstellen 
+- entferne nachlaufende leerstellen
 
 ## Was sol ich überprüfen  ?
-Jegliche Ungereimtheiten zwischen den scans und den Code in die repository, einschließlich: 
 
-### Kommentare 
+Jegliche Ungereimtheiten zwischen den scans und den Code in die repository, einschließlich:
+
+### Kommentare
+
 - Kommentare in dem Abgeschriebenen Code müssen denen in den scans gleichen
-  - Das könnte extra einen sprachlichen Fehler oder das entfernen/hinzufügen eines ganzen Kommentars bedeuten 
-  
+  - Das könnte extra einen sprachlichen Fehler oder das entfernen/hinzufügen eines ganzen Kommentars bedeuten
+
 ### Zeilenumbruch
-- Zeilenumbruch *mit* `R0000` in Spalte 1 sollte genau mit den scans übereinstimmen 
+
+- Zeilenumbruch *mit* `R0000` in Spalte 1 sollte genau mit den scans übereinstimmen
 - Zeilenumbruch *mit**__out__* `R0000` in Spalte 1 sollte nur 1 bis zwei Leerzeilen nacheinander haben
   - Wenn dort mher als 2 leere Zeilenumbrüche sind sollen diese entfernt werden
-    - Zeilen mit `R0000` in Spalte 1 zählen nicht dazu 
-  - In den Quell Bildern, Diese wurden verursacht durch eine nicht gedruckte stelle in in Spalte 8. A 2 dort hat eine doppelte Leerstelle (einezilne Leerzeile) und A 3 hat eine dreifache Leerstelle (doppelte Leerzeile). Werte 4-8 wurden definiert aber nie benutzt. Mehr hier zu in [#159][7] 
-  
+    - Zeilen mit `R0000` in Spalte 1 zählen nicht dazu
+  - In den Quell Bildern, Diese wurden verursacht durch eine nicht gedruckte stelle in in Spalte 8. A 2 dort hat eine doppelte Leerstelle (einezilne Leerzeile) und A 3 hat eine dreifache Leerstelle (doppelte Leerzeile). Werte 4-8 wurden definiert aber nie benutzt. Mehr hier zu in [#159][7]
+
 zum Beispiel das Folgende:
+
 ```plain
 R0819   SUBROUTINE TO SKIP...
 R0820
@@ -87,7 +93,9 @@ R0820
 
  0821   LAMPTEST  CS  IMODES33
 ```
+
 sollte werden:
+
 ```plain
 R0819   SUBROUTINE TO SKIP...
 R0820

diff --git a/CONTRIBUTING.es.md b/CONTRIBUTING.es.md
@@ -27,12 +27,13 @@
 
 El código fuente en este repositorio se digitalizó manualmente a partir de impresiones en papel, por lo que los errores tipográficos y otras discrepancias se han introducido accidentalmente. El código se modificará para que sea coherente con las impresiones escaneadas:
 
-* [AGC impresiones para Comanche][8]
-* [AGC impresiones para Luminary][9]
+- [AGC impresiones para Comanche][8]
+- [AGC impresiones para Luminary][9]
 
 ## Extensiones Útiles
 
 GitHub tiene soporte de sintaxis para el lenguaje ensamblador AGC incorporado. Lamentablemente, su editor de código no lo hará, sin embargo, hay extensiones de lenguaje AGC que proporcionan resaltado de sintaxis para los siguientes editores:
+
 - [Atom][Atom]†
 - [CodeBlocks][CodeBlocks]
 - [Eclipse][Eclipse]
@@ -58,27 +59,32 @@ GitHub tiene soporte de sintaxis para el lenguaje ensamblador AGC incorporado. L
 [jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
 
 ## Formateo
+
 **Nota:** GitHub y las extensiones marcadas anteriormente asegurarán que esté utilizando el formato correcto automáticamente.
 
 - Usar sangría de tabulación
 - Use un ancho de pestaña de 8
 - Recortar espacios en blanco al final
 
 ## ¿Qué verifico?
+
 Cualquier discrepancia entre los escaneos y el código fuente en este repositorio, incluyendo:
 
 ### Comentarios
+
 - Los comentarios en el código transcrito deben coincidir exactamente con los escaneos
   - Esto podría implicar crear un error tipográfico deliberado o eliminar / agregar un comentario completo.
 
 ### Saltos de línea
+
 - Salto de línea *with* `R0000` en la columna 1 debe coincidir exactamente con los escaneos.
 - Salto de línea *with**__out__* `R0000` en la columna 1 debe contener solo 1 ó 2 líneas en blanco en una fila.
   - Si hay más de 2 saltos de línea en blanco, elimine los saltos de línea adicionales.
     - Líneas con `R0000` en la columna 1 no cuentan para esto.
   - En las imágenes de origen, éstas fueron creadas por un dígito sin imprimir en la columna 8. A 2 forzó un doble espacio (línea en blanco simple) y un 3 forzó un espacio triple (línea en blanco doble). Los valores 4-8 se definieron pero nunca se usaron. Lea más sobre esto en [#159][7]
 
 Por ejemplo lo siguiente:
+
 ```plain
 R0819   SUBROUTINE TO SKIP...
 R0820
@@ -87,7 +93,9 @@ R0820
 
  0821   LAMPTEST  CS  IMODES33
 ```
+
 Debe convertirse:
+
 ```plain
 R0819   SUBROUTINE TO SKIP...
 R0820
@@ -97,17 +105,21 @@ R0820
 ```
 
 ### Espacios
+
 - Los espacios entre dos caracteres en la cadena deben respetar la siguiente convención (vea la discusión en [#316][10]):
   - Espacio único para nuevas palabras.
   - Doble espacio para nuevas oraciones.
   - Triple espacio para hendiduras.
 
 Por ejemplo lo siguiente:
+
 ```plain
 	1)  FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
 	GARPLY, WALDO.
 ```
+
 Debe convertirse:
+
 ```plain
 	1) FOO BAR BAZ QUX QUUX QUUZ.  CORGE, GRAULT,
 	   GARPLY, WALDO.

diff --git a/CONTRIBUTING.fr.md b/CONTRIBUTING.fr.md
@@ -27,12 +27,13 @@
 
 Le code source de ce dépôt a été numérisé manuellement à partir d’imprimés papier, de sorte que les fautes de frappe et autres anomalies ont été introduites accidentellement. Le code doit être modifié pour être cohérent avec les impressions numérisées:
 
-* [Impressions AGC pour Comanche][8]
-* [Impressions AGC pour Luminary][9]
+- [Impressions AGC pour Comanche][8]
+- [Impressions AGC pour Luminary][9]
 
 ## Extensions utiles
 
 Github prend en charge nativement la syntaxe pour le langage assembleur AGC. Malheureusement, votre éditeur de texte ne l’aura pas. Mais il y a des extensions pour le langage AGC pour les éditeurs suivants:
+
 - [Atom][Atom]†
 - [CodeBlocks][CodeBlocks]
 - [Eclipse][Eclipse]
@@ -58,27 +59,32 @@ Github prend en charge nativement la syntaxe pour le langage assembleur AGC. Mal
 [jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
 
 ## Mise en page
+
 **Note:** GitHub et les extensions marquées ci-dessus vous assureront d'utiliser automatiquement le bon formatage.
 
 - Indenter avec tabulation
 - Les tabulations ont une taille de 8
 - Pas d'espace à la fin des ligne
 
 ## Comment vérifier ?
+
 Tout écart entre les scans et le code source dans ce référentiel, y compris :
 
 ### Commentaires
+
 - Les commentaires dans le code transcrit doivent correspondre exactement aux scans
   - Cela peut impliquer de créer délibérément une erreur de frappe  ou de supprimer/ajouter un commentaire entier.
 
 ### Sauts de ligne
+
 - Les lignes *avec* `R0000` dans la colonne 1 doivent correspondre exactement aux scans.
 - Les sauts de ligne *sans* `R0000` dans la colonne 1 ne doivent contenir que 1 ou 2 lignes vides d'affilée.
   - Si il y a plus de 2 lignes vides, supprimer les sauts de ligne supplémentaires.
     - Ne pas prendre en compte les lignes avecc `R0000` dans la cononne 1.
   - Dans les images sources, il y a digits non imprimés dans la colonne 8. Un 2 force un double espace (une seul ligne vide) et un 3 force une triple espace (double ligne vide). Les valeurs 4-8 ont été définies mais n’ont jamais été utilisées. Pour en savoir plus [#159][7]
 
 Par exemple, ce qui suit:
+
 ```plain
 R0819   SUBROUTINE TO SKIP...
 R0820
@@ -87,7 +93,9 @@ R0820
 
  0821   LAMPTEST  CS  IMODES33
 ```
+
 Doit devenir:
+
 ```plain
 R0819   SUBROUTINE TO SKIP...
 R0820
@@ -97,17 +105,21 @@ R0820
 ```
 
 ### Espaces
+
 - Les espaces entre deux caractères doivent respecter la convention suivante (voir la discussion [#316][10]):
   - Un seul espace pour un nouveau mot.
   - Deux espaces pour une nouvelle phrase.
   - Trois espaces pour l'indentations.
 
 Par exemple, ce qui suit:
+
 ```plain
 	1)  FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
 	GARPLY, WALDO.
 ```
+
 Doit devenir:
+
 ```plain
 	1) FOO BAR BAZ QUX QUUX QUUZ.  CORGE, GRAULT,
 	   GARPLY, WALDO.