Skip to content

Commit f9dc719

Browse files
davorpadavorpa
committed
docs(contributing): Homogenize format & indent of code blocks
- Format using fenced style. - Well indent in those placed inside list enumerations. - Simulate `Good` - `Bad` monospace double colon indent inside each one. - Examples highlighting as `text-plain`. The `md, markdown` style doesn't work very well since blocks has mixed syntax. - `check_urls` code block highlighted as `properties` style (key-value pair). Solves markdownlint rules: - MD040/fenced-code-language: Fenced code blocks should have a language specified - MD046/code-block-style: Code block style [Expected: indented; Actual: fenced]
1 parent 31c776c commit f9dc719

14 files changed

+587
-563
lines changed

‎CONTRIBUTING-de.md

+41-39
Original file line numberDiff line numberDiff line change
@@ -73,63 +73,65 @@ Folgende Formatierungsregeln sollten eingehalten werden:
7373

7474
Beispiel:
7575

76-
[...]
77-
* [Ein tolles Buch](http://example.com/example.html)
78-
(Leerzeile)
79-
(Leerzeile)
80-
### Beispiel
81-
(Leerzeile)
82-
* [Noch ein tolles Buch](http://example.com/book.html)
83-
* [Ein anderes Buch](http://example.com/other.html)
76+
```text
77+
[...]
78+
* [Ein tolles Buch](http://example.com/example.html)
79+
(Leerzeile)
80+
(Leerzeile)
81+
### Beispiel
82+
(Leerzeile)
83+
* [Noch ein tolles Buch](http://example.com/book.html)
84+
* [Ein anderes Buch](http://example.com/other.html)
85+
```
8486

8587
- Keine Leerzeichen zwischen `]` und `(` einfügen:
8688

87-
```
88-
FALSCH : * [Noch ein tolles Buch] (http://example.com/book.html)
89-
RICHTIG: * [Noch ein tolles Buch](http://example.com/book.html)
90-
```
89+
```text
90+
FALSCH : * [Noch ein tolles Buch] (http://example.com/book.html)
91+
RICHTIG: * [Noch ein tolles Buch](http://example.com/book.html)
92+
```
9193
9294
- Wenn Du den Autor nennst, nutze ` - ` (einen mit Leerzeichen eingefassten Gedankenstrich):
9395
94-
```
95-
FALSCH : * [Noch ein tolles Buch](http://example.com/book.html)- John Doe
96-
RICHTIG: * [Noch ein tolles Buch](http://example.com/book.html) - John Doe
97-
```
96+
```text
97+
FALSCH : * [Noch ein tolles Buch](http://example.com/book.html)- John Doe
98+
RICHTIG: * [Noch ein tolles Buch](http://example.com/book.html) - John Doe
99+
```
98100
99101
- Füge ein einzelnes Leerzeichen zwischen dem Link und seinem Dateiformat ein:
100102
101-
```
102-
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.pdf)(PDF)
103-
RICHTIG: * [Ein sehr tolles Buch](https://example.org/book.pdf) (PDF)
104-
```
103+
```text
104+
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.pdf)(PDF)
105+
RICHTIG: * [Ein sehr tolles Buch](https://example.org/book.pdf) (PDF)
106+
```
105107
106108
- Der Autor wird vor dem Format genannt:
107109
108-
```
109-
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.pdf)- (PDF) Jane Roe
110-
RICHTIG: * [Ein sehr tolles Buch](https://example.org/book.pdf) - Jane Roe (PDF)
111-
```
110+
```text
111+
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.pdf)- (PDF) Jane Roe
112+
RICHTIG: * [Ein sehr tolles Buch](https://example.org/book.pdf) - Jane Roe (PDF)
113+
```
112114
113115
- Verschiedene Formate:
114116
115-
```
116-
FALSCH : * [Noch ein tolles Buch](http://example.com/)- John Doe (HTML)
117-
FALSCH : * [Noch ein tolles Buch](https://downloads.example.org/book.html)- John Doe (download site)
118-
RICHTIG: * [Noch ein tolles Buch](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
119-
```
117+
```text
118+
FALSCH : * [Noch ein tolles Buch](http://example.com/)- John Doe (HTML)
119+
FALSCH : * [Noch ein tolles Buch](https://downloads.example.org/book.html)- John Doe (download site)
120+
RICHTIG: * [Noch ein tolles Buch](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
121+
```
120122
121123
- Nenne das Jahr der Veröffentlichung im Titel bei älteren Publikationen:
122124
123-
```
124-
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.html) - Jane Roe - 1970
125-
RICHTIG: * [Ein sehr tolles Buch (1970)](https://example.org/book.html) - Jane Roe
126-
```
125+
```text
126+
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.html) - Jane Roe - 1970
127+
RICHTIG: * [Ein sehr tolles Buch (1970)](https://example.org/book.html) - Jane Roe
128+
```
127129
128130
- <a name="in_process"></a>Bücher in Bearbeitung:
129131
130-
```
131-
RICHTIG: * [Wird bald ein tolles Buch sein](http://example.com/book2.html) - John Doe (HTML) (:construction: *in Bearbeitung*)
132-
```
132+
```text
133+
RICHTIG: * [Wird bald ein tolles Buch sein](http://example.com/book2.html) - John Doe (HTML) (:construction: *in Bearbeitung*)
134+
```
133135
134136
135137
### Hinweise
@@ -228,9 +230,9 @@ Wenn etwas ausgedruckt werden kann, ohne dass es seinen Nutzen verliert, ist es
228230
- Die URLs werden über [awesome_bot](https://github.com/dkhamsing/awesome_bot) validiert.
229231
- Um die URL-Validierung auszulösen, kann ein Commit abgeschickt werden, der `check_urls=file_to_check` enthält:
230232
231-
```
232-
check_urls=free-programming-books.md free-programming-books-en.md
233-
```
233+
```properties
234+
check_urls=free-programming-books.md free-programming-books-de.md
235+
```
234236
235237
- Man kann mehr als eine zu überprüfende Datei angeben, wobei die Einträge mit einem einzelnen Leerzeichen getrennt werden.
236238
- Bei Angabe von mehr als einer Datei basiert das Ergebnis des Builds auf dem Ergebnis der letzten geprüften Datei. Du solltest Dir darüber im Klaren sein, dass dies zu gültigen Builds führen kann und daher das Build Protokoll am Ende des Pull Request durch Klick auf "Show all checks" -> "Details" genau geprüft werden sollte.

‎CONTRIBUTING-el.md

+44-42
Original file line numberDiff line numberDiff line change
@@ -79,69 +79,71 @@
7979

8080
Παράδειγμα:
8181

82-
[...]
83-
* [Ένα Φοβερό Βιβλίο](http://example.com/example.html)
84-
(κενή γραμμή)
85-
(κενή γραμμή)
86-
### Παράδειγμα
87-
(κενή γραμμή)
88-
* [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)
89-
* [Κάποιο Άλλο Βιβλίο](http://example.com/other.html)
82+
```text
83+
[...]
84+
* [Ένα Φοβερό Βιβλίο](http://example.com/example.html)
85+
(κενή γραμμή)
86+
(κενή γραμμή)
87+
### Παράδειγμα
88+
(κενή γραμμή)
89+
* [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)
90+
* [Κάποιο Άλλο Βιβλίο](http://example.com/other.html)
91+
```
9092

9193
- Μη βάζετε κενό μεταξύ `]` και `(`:
9294

93-
```
94-
ΚΑΚΟ: * [Άλλο Φοβερό Βιβλίο] (http://example.com/book.html)
95-
ΚΑΛΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)
96-
```
95+
```text
96+
ΚΑΚΟ: * [Άλλο Φοβερό Βιβλίο] (http://example.com/book.html)
97+
ΚΑΛΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)
98+
```
9799
98100
- Αν συμπεριλαμβάνετε συγγραφέα, χρησιμοποιήστε ` - ` (μια παύλα που περιβάλλεται από κενά):
99101
100-
```
101-
ΚΑΚΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)- John Doe
102-
ΚΑΛΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html) - John Doe
103-
```
102+
```text
103+
ΚΑΚΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)- John Doe
104+
ΚΑΛΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html) - John Doe
105+
```
104106
105107
- Εισάγετε ένα κενό μεταξύ του συνδέσμου και του format του:
106108
107-
```
108-
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf)(PDF)
109-
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf) (PDF)
110-
```
109+
```text
110+
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf)(PDF)
111+
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf) (PDF)
112+
```
111113
112114
- Ο συγγραφέας μπαίνει πριν το format
113115
114-
```
115-
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf)- (PDF) Jane Roe
116-
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf) - Jane Roe (PDF)
117-
```
116+
```text
117+
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf)- (PDF) Jane Roe
118+
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf) - Jane Roe (PDF)
119+
```
118120
119121
- Πολλαπλά formats:
120122
121-
```
122-
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](http://example.com/)- John Doe (HTML)
123-
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://downloads.example.org/book.html)- John Doe (download site)
124-
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
125-
```
123+
```text
124+
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](http://example.com/)- John Doe (HTML)
125+
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://downloads.example.org/book.html)- John Doe (download site)
126+
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
127+
```
126128
127129
- Συμπεριλαμβάνετε χρονιά δημοσιεύσης στον τίτλο για παλαιότερα βιβλία:
128130
129-
```
130-
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.html) - Jane Roe - 1970
131-
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο (1970)](https://example.org/book.html) - Jane Roe
132-
```
131+
```text
132+
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.html) - Jane Roe - 1970
133+
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο (1970)](https://example.org/book.html) - Jane Roe
134+
```
133135
134136
- <a name="in_process"></a>Βιβλία σε εξέλιξη:
135137
136-
```
137-
ΚΑΛΟ: * [Θα Είναι Σύντομα Ένα Φοβερό Βιβλίο](http://example.com/book2.html) - John Doe (HTML) (:construction: *σε εξέλιξη*)
138-
```
138+
```text
139+
ΚΑΛΟ: * [Θα Είναι Σύντομα Ένα Φοβερό Βιβλίο](http://example.com/book2.html) - John Doe (HTML) (:construction: *σε εξέλιξη*)
140+
```
139141
140142
- <a name="archived"></a>Αρχειοθετημένοι σύνδεσμοι:
141143
142-
```
143-
ΚΑΛΟ: * [Ένα Ενδιαφέρον Way-backed Βιβλίο](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: αρχειοθετημένο)*
144-
```
144+
```text
145+
ΚΑΛΟ: * [Ένα Ενδιαφέρον Way-backed Βιβλίο](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: αρχειοθετημένο)*
146+
```
145147
146148
147149
<a name="notes"></a>
@@ -243,9 +245,9 @@
243245
- Η επικύρωση των URL χρησιμοποιεί το [awesome_bot](https://github.com/dkhamsing/awesome_bot)
244246
- Για να ενεργοποιήσετε την επικύρωση του URL, κάντε push ένα commit που περιέχει ένα μήνυμα στο οποίο υπάρχει το `check_urls=file_to_check`:
245247
246-
```
247-
check_urls=free-programming-books.md free-programming-books-en.md
248-
```
248+
```properties
249+
check_urls=free-programming-books.md free-programming-books-el.md
250+
```
249251
250252
- Μπορείτε να προσδιορίσετε πάνω από ένα αρχείο για έλεγχο, χρησιμοποιώντας ένα κενό για να ξεχωρίσετε κάθε καταχώρηση.
251253
- Αν προσδιορίσετε πάνω από ένα αρχείο, τα αποτελέσματα του build βασίζονται στα αποτελέσματα του τελευταίου αρχείου που ελέγχθηκε. Θα πρέπει να γνωρίζετε ότι ενδέχεται να πάρετε επικυρωμένα builds εξαιτίας αυτού οπότε να είστε σίγουροι ότι επιβλέπετε το αρχείο του build στο τέλος του pull request πατώντας στο "Show all checks" -> "Details".

‎CONTRIBUTING-es.md

+43-41
Original file line numberDiff line numberDiff line change
@@ -79,69 +79,71 @@ La idea es tener:
7979

8080
Ejemplo:
8181

82-
[...]
83-
* [Un libro increíble](http://example.com/example.html)
84-
(línea en blanco)
85-
(línea en blanco)
86-
### Sección de ejemplo
87-
(línea en blanco)
88-
* [Otro libro fascinante](http://example.com/book.html)
89-
* [Otro libro más](http://example.com/other.html)
82+
```text
83+
[...]
84+
* [Un libro increíble](http://example.com/example.html)
85+
(línea en blanco)
86+
(línea en blanco)
87+
### Sección de ejemplo
88+
(línea en blanco)
89+
* [Otro libro fascinante](http://example.com/book.html)
90+
* [Otro libro más](http://example.com/other.html)
91+
```
9092

9193
- Omita los espacios entre `]` y `(`:
9294

93-
```
94-
INCORRECTO : * [Otro libro fascinante] (http://example.com/book.html)
95-
CORRECTO : * [Otro libro fascinante](http://example.com/book.html)
96-
```
95+
```text
96+
INCORRECTO: * [Otro libro fascinante] (http://example.com/book.html)
97+
CORRECTO : * [Otro libro fascinante](http://example.com/book.html)
98+
```
9799
98100
- Si en el registro decide incluir al autor, emplee ` - ` (un guión rodeado de espacios simples) como separador:
99101
100-
```
101-
INCORRECTO : * [Un libro sencillamente fabuloso](http://example.com/book.html)- John Doe
102-
CORRECTO : * [Un libro sencillamente fabuloso](http://example.com/book.html) - John Doe
103-
```
102+
```text
103+
INCORRECTO: * [Un libro sencillamente fabuloso](http://example.com/book.html)- John Doe
104+
CORRECTO : * [Un libro sencillamente fabuloso](http://example.com/book.html) - John Doe
105+
```
104106
105107
- Ponga un solo espacio entre el enlace al contenido y su formato:
106108
107-
```
108-
INCORRECTO : * [Un libro muy interesante](https://example.org/book.pdf)(PDF)
109-
CORRECTO : * [Un libro muy interesante](https://example.org/book.pdf) (PDF)
110-
```
109+
```text
110+
INCORRECTO: * [Un libro muy interesante](https://example.org/book.pdf)(PDF)
111+
CORRECTO : * [Un libro muy interesante](https://example.org/book.pdf) (PDF)
112+
```
111113
112114
- El autor se antepone al formato:
113115
114-
```
115-
INCORRECTO : * [Un libro muy interesante](https://example.org/book.pdf)- (PDF) Jane Roe
116-
CORRECTO : * [Un libro muy interesante](https://example.org/book.pdf) - Jane Roe (PDF)
117-
```
116+
```text
117+
INCORRECTO: * [Un libro muy interesante](https://example.org/book.pdf)- (PDF) Jane Roe
118+
CORRECTO : * [Un libro muy interesante](https://example.org/book.pdf) - Jane Roe (PDF)
119+
```
118120
119121
- Múltiples formatos:
120122
121-
```
122-
INCORRECTO : * [Otro libro interesante](http://example.com/) - John Doe (HTML)
123-
INCORRECTO : * [Otro libro interesante](https://downloads.example.org/book.html) - John Doe (sitio de descarga)
124-
CORRECTO : * [Otro libro interesante](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
125-
```
123+
```text
124+
INCORRECTO: * [Otro libro interesante](http://example.com/) - John Doe (HTML)
125+
INCORRECTO: * [Otro libro interesante](https://downloads.example.org/book.html) - John Doe (sitio de descarga)
126+
CORRECTO : * [Otro libro interesante](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
127+
```
126128
127129
- Incluya el año de publicación como parte del título de los libros más antiguos:
128130
129-
```
130-
INCORRECTO : * [Un libro bastante especial](https://example.org/book.html) - Jane Roe - 1970
131-
CORRECTO : * [Un libro bastante especial (1970)](https://example.org/book.html) - Jane Roe
132-
```
131+
```text
132+
INCORRECTO: * [Un libro bastante especial](https://example.org/book.html) - Jane Roe - 1970
133+
CORRECTO : * [Un libro bastante especial (1970)](https://example.org/book.html) - Jane Roe
134+
```
133135
134136
- <a name="in_process"></a>Libros en proceso / no acabados aún:
135137
136-
```
137-
CORRECTO: * [A punto de ser un libro fascinante](http://example.com/book2.html) - John Doe (HTML) (:construction: *en proceso*)
138-
```
138+
```text
139+
CORRECTO : * [A punto de ser un libro fascinante](http://example.com/book2.html) - John Doe (HTML) (:construction: *en proceso*)
140+
```
139141
140142
- <a name="archived"></a>Enlaces archivados:
141143
142-
```
143-
CORRECTO: * [Un recurso recuperado a partir de su línea de tiempo](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archivado)*
144-
```
144+
```text
145+
CORRECTO : * [Un recurso recuperado a partir de su línea de tiempo](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archivado)*
146+
```
145147
146148
147149
<a name="notes"></a>
@@ -252,8 +254,8 @@ Si es posible imprimirlo y conservar su esencia, no es un Tutorial Interactivo.
252254
- La validación de URLs se realiza mediante [awesome_bot](https://github.com/dkhamsing/awesome_bot)
253255
- Para activar esta validación de URL, envíe un commit que incluya como mensaje de confirmación `check_urls=fichero_a_comprobar`:
254256
255-
```
256-
check_urls=free-programming-books.md free-programming-books-en.md
257+
```properties
258+
check_urls=free-programming-books.md free-programming-books-es.md
257259
```
258260
259261
- Es posible especificar más de un fichero a comprobar. Simplemente use un espacio para separar cada entrada.

0 commit comments

Comments
 (0)