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]
pull/6625/head
David Ordás 2021-11-04 21:17:29 +01:00
parent 31c776cb52
commit f9dc719aef
14 changed files with 587 additions and 563 deletions

View File

@ -73,63 +73,65 @@ Folgende Formatierungsregeln sollten eingehalten werden:
Beispiel: Beispiel:
[...] ```text
* [Ein tolles Buch](http://example.com/example.html) [...]
(Leerzeile) * [Ein tolles Buch](http://example.com/example.html)
(Leerzeile) (Leerzeile)
### Beispiel (Leerzeile)
(Leerzeile) ### Beispiel
* [Noch ein tolles Buch](http://example.com/book.html) (Leerzeile)
* [Ein anderes Buch](http://example.com/other.html) * [Noch ein tolles Buch](http://example.com/book.html)
* [Ein anderes Buch](http://example.com/other.html)
```
- Keine Leerzeichen zwischen `]` und `(` einfügen: - Keine Leerzeichen zwischen `]` und `(` einfügen:
``` ```text
FALSCH : * [Noch ein tolles Buch] (http://example.com/book.html) FALSCH : * [Noch ein tolles Buch] (http://example.com/book.html)
RICHTIG: * [Noch ein tolles Buch](http://example.com/book.html) RICHTIG: * [Noch ein tolles Buch](http://example.com/book.html)
``` ```
- Wenn Du den Autor nennst, nutze ` - ` (einen mit Leerzeichen eingefassten Gedankenstrich): - Wenn Du den Autor nennst, nutze ` - ` (einen mit Leerzeichen eingefassten Gedankenstrich):
``` ```text
FALSCH : * [Noch ein tolles Buch](http://example.com/book.html)- John Doe FALSCH : * [Noch ein tolles Buch](http://example.com/book.html)- John Doe
RICHTIG: * [Noch ein tolles Buch](http://example.com/book.html) - John Doe RICHTIG: * [Noch ein tolles Buch](http://example.com/book.html) - John Doe
``` ```
- Füge ein einzelnes Leerzeichen zwischen dem Link und seinem Dateiformat ein: - Füge ein einzelnes Leerzeichen zwischen dem Link und seinem Dateiformat ein:
``` ```text
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.pdf)(PDF) FALSCH : * [Ein sehr tolles Buch](https://example.org/book.pdf)(PDF)
RICHTIG: * [Ein sehr tolles Buch](https://example.org/book.pdf) (PDF) RICHTIG: * [Ein sehr tolles Buch](https://example.org/book.pdf) (PDF)
``` ```
- Der Autor wird vor dem Format genannt: - Der Autor wird vor dem Format genannt:
``` ```text
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.pdf)- (PDF) Jane Roe FALSCH : * [Ein sehr tolles Buch](https://example.org/book.pdf)- (PDF) Jane Roe
RICHTIG: * [Ein sehr tolles Buch](https://example.org/book.pdf) - Jane Roe (PDF) RICHTIG: * [Ein sehr tolles Buch](https://example.org/book.pdf) - Jane Roe (PDF)
``` ```
- Verschiedene Formate: - Verschiedene Formate:
``` ```text
FALSCH : * [Noch ein tolles Buch](http://example.com/)- John Doe (HTML) FALSCH : * [Noch ein tolles Buch](http://example.com/)- John Doe (HTML)
FALSCH : * [Noch ein tolles Buch](https://downloads.example.org/book.html)- John Doe (download site) FALSCH : * [Noch ein tolles Buch](https://downloads.example.org/book.html)- John Doe (download site)
RICHTIG: * [Noch ein tolles Buch](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) RICHTIG: * [Noch ein tolles Buch](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- Nenne das Jahr der Veröffentlichung im Titel bei älteren Publikationen: - Nenne das Jahr der Veröffentlichung im Titel bei älteren Publikationen:
``` ```text
FALSCH : * [Ein sehr tolles Buch](https://example.org/book.html) - Jane Roe - 1970 FALSCH : * [Ein sehr tolles Buch](https://example.org/book.html) - Jane Roe - 1970
RICHTIG: * [Ein sehr tolles Buch (1970)](https://example.org/book.html) - Jane Roe RICHTIG: * [Ein sehr tolles Buch (1970)](https://example.org/book.html) - Jane Roe
``` ```
- <a name="in_process"></a>Bücher in Bearbeitung: - <a name="in_process"></a>Bücher in Bearbeitung:
``` ```text
RICHTIG: * [Wird bald ein tolles Buch sein](http://example.com/book2.html) - John Doe (HTML) (:construction: *in Bearbeitung*) RICHTIG: * [Wird bald ein tolles Buch sein](http://example.com/book2.html) - John Doe (HTML) (:construction: *in Bearbeitung*)
``` ```
### Hinweise ### Hinweise
@ -228,9 +230,9 @@ Wenn etwas ausgedruckt werden kann, ohne dass es seinen Nutzen verliert, ist es
- Die URLs werden über [awesome_bot](https://github.com/dkhamsing/awesome_bot) validiert. - Die URLs werden über [awesome_bot](https://github.com/dkhamsing/awesome_bot) validiert.
- Um die URL-Validierung auszulösen, kann ein Commit abgeschickt werden, der `check_urls=file_to_check` enthält: - Um die URL-Validierung auszulösen, kann ein Commit abgeschickt werden, der `check_urls=file_to_check` enthält:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-de.md
``` ```
- Man kann mehr als eine zu überprüfende Datei angeben, wobei die Einträge mit einem einzelnen Leerzeichen getrennt werden. - Man kann mehr als eine zu überprüfende Datei angeben, wobei die Einträge mit einem einzelnen Leerzeichen getrennt werden.
- 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. - 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.

View File

@ -79,69 +79,71 @@
Παράδειγμα: Παράδειγμα:
[...] ```text
* [Ένα Φοβερό Βιβλίο](http://example.com/example.html) [...]
(κενή γραμμή) * [Ένα Φοβερό Βιβλίο](http://example.com/example.html)
(κενή γραμμή) (κενή γραμμή)
### Παράδειγμα (κενή γραμμή)
(κενή γραμμή) ### Παράδειγμα
* [Άλλο Φοβερό Βιβλίο](http://example.com/book.html) (κενή γραμμή)
* [Κάποιο Άλλο Βιβλίο](http://example.com/other.html) * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)
* [Κάποιο Άλλο Βιβλίο](http://example.com/other.html)
```
- Μη βάζετε κενό μεταξύ `]` και `(`: - Μη βάζετε κενό μεταξύ `]` και `(`:
``` ```text
ΚΑΚΟ: * [Άλλο Φοβερό Βιβλίο] (http://example.com/book.html) ΚΑΚΟ: * [Άλλο Φοβερό Βιβλίο] (http://example.com/book.html)
ΚΑΛΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html) ΚΑΛΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)
``` ```
- Αν συμπεριλαμβάνετε συγγραφέα, χρησιμοποιήστε ` - ` (μια παύλα που περιβάλλεται από κενά): - Αν συμπεριλαμβάνετε συγγραφέα, χρησιμοποιήστε ` - ` (μια παύλα που περιβάλλεται από κενά):
``` ```text
ΚΑΚΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)- John Doe ΚΑΚΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html)- John Doe
ΚΑΛΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html) - John Doe ΚΑΛΟ: * [Άλλο Φοβερό Βιβλίο](http://example.com/book.html) - John Doe
``` ```
- Εισάγετε ένα κενό μεταξύ του συνδέσμου και του format του: - Εισάγετε ένα κενό μεταξύ του συνδέσμου και του format του:
``` ```text
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf)(PDF) ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf)(PDF)
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf) (PDF) ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf) (PDF)
``` ```
- Ο συγγραφέας μπαίνει πριν το format - Ο συγγραφέας μπαίνει πριν το format
``` ```text
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf)- (PDF) Jane Roe ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf)- (PDF) Jane Roe
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf) - Jane Roe (PDF) ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.pdf) - Jane Roe (PDF)
``` ```
- Πολλαπλά formats: - Πολλαπλά formats:
``` ```text
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](http://example.com/)- John Doe (HTML) ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](http://example.com/)- John Doe (HTML)
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://downloads.example.org/book.html)- John Doe (download site) ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://downloads.example.org/book.html)- John Doe (download site)
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- Συμπεριλαμβάνετε χρονιά δημοσιεύσης στον τίτλο για παλαιότερα βιβλία: - Συμπεριλαμβάνετε χρονιά δημοσιεύσης στον τίτλο για παλαιότερα βιβλία:
``` ```text
ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.html) - Jane Roe - 1970 ΚΑΚΟ: * [Ένα Πολύ Φοβερό Βιβλίο](https://example.org/book.html) - Jane Roe - 1970
ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο (1970)](https://example.org/book.html) - Jane Roe ΚΑΛΟ: * [Ένα Πολύ Φοβερό Βιβλίο (1970)](https://example.org/book.html) - Jane Roe
``` ```
- <a name="in_process"></a>Βιβλία σε εξέλιξη: - <a name="in_process"></a>Βιβλία σε εξέλιξη:
``` ```text
ΚΑΛΟ: * [Θα Είναι Σύντομα Ένα Φοβερό Βιβλίο](http://example.com/book2.html) - John Doe (HTML) (:construction: *σε εξέλιξη*) ΚΑΛΟ: * [Θα Είναι Σύντομα Ένα Φοβερό Βιβλίο](http://example.com/book2.html) - John Doe (HTML) (:construction: *σε εξέλιξη*)
``` ```
- <a name="archived"></a>Αρχειοθετημένοι σύνδεσμοι: - <a name="archived"></a>Αρχειοθετημένοι σύνδεσμοι:
``` ```text
ΚΑΛΟ: * [Ένα Ενδιαφέρον Way-backed Βιβλίο](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: αρχειοθετημένο)* ΚΑΛΟ: * [Ένα Ενδιαφέρον Way-backed Βιβλίο](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: αρχειοθετημένο)*
``` ```
<a name="notes"></a> <a name="notes"></a>
@ -243,9 +245,9 @@
- Η επικύρωση των URL χρησιμοποιεί το [awesome_bot](https://github.com/dkhamsing/awesome_bot) - Η επικύρωση των URL χρησιμοποιεί το [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- Για να ενεργοποιήσετε την επικύρωση του URL, κάντε push ένα commit που περιέχει ένα μήνυμα στο οποίο υπάρχει το `check_urls=file_to_check`: - Για να ενεργοποιήσετε την επικύρωση του URL, κάντε push ένα commit που περιέχει ένα μήνυμα στο οποίο υπάρχει το `check_urls=file_to_check`:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-el.md
``` ```
- Μπορείτε να προσδιορίσετε πάνω από ένα αρχείο για έλεγχο, χρησιμοποιώντας ένα κενό για να ξεχωρίσετε κάθε καταχώρηση. - Μπορείτε να προσδιορίσετε πάνω από ένα αρχείο για έλεγχο, χρησιμοποιώντας ένα κενό για να ξεχωρίσετε κάθε καταχώρηση.
- Αν προσδιορίσετε πάνω από ένα αρχείο, τα αποτελέσματα του build βασίζονται στα αποτελέσματα του τελευταίου αρχείου που ελέγχθηκε. Θα πρέπει να γνωρίζετε ότι ενδέχεται να πάρετε επικυρωμένα builds εξαιτίας αυτού οπότε να είστε σίγουροι ότι επιβλέπετε το αρχείο του build στο τέλος του pull request πατώντας στο "Show all checks" -> "Details". - Αν προσδιορίσετε πάνω από ένα αρχείο, τα αποτελέσματα του build βασίζονται στα αποτελέσματα του τελευταίου αρχείου που ελέγχθηκε. Θα πρέπει να γνωρίζετε ότι ενδέχεται να πάρετε επικυρωμένα builds εξαιτίας αυτού οπότε να είστε σίγουροι ότι επιβλέπετε το αρχείο του build στο τέλος του pull request πατώντας στο "Show all checks" -> "Details".

View File

@ -79,69 +79,71 @@ La idea es tener:
Ejemplo: Ejemplo:
[...] ```text
* [Un libro increíble](http://example.com/example.html) [...]
(línea en blanco) * [Un libro increíble](http://example.com/example.html)
(línea en blanco) (línea en blanco)
### Sección de ejemplo (línea en blanco)
(línea en blanco) ### Sección de ejemplo
* [Otro libro fascinante](http://example.com/book.html) (línea en blanco)
* [Otro libro más](http://example.com/other.html) * [Otro libro fascinante](http://example.com/book.html)
* [Otro libro más](http://example.com/other.html)
```
- Omita los espacios entre `]` y `(`: - Omita los espacios entre `]` y `(`:
``` ```text
INCORRECTO : * [Otro libro fascinante] (http://example.com/book.html) INCORRECTO: * [Otro libro fascinante] (http://example.com/book.html)
CORRECTO : * [Otro libro fascinante](http://example.com/book.html) CORRECTO : * [Otro libro fascinante](http://example.com/book.html)
``` ```
- Si en el registro decide incluir al autor, emplee ` - ` (un guión rodeado de espacios simples) como separador: - Si en el registro decide incluir al autor, emplee ` - ` (un guión rodeado de espacios simples) como separador:
``` ```text
INCORRECTO : * [Un libro sencillamente fabuloso](http://example.com/book.html)- John Doe INCORRECTO: * [Un libro sencillamente fabuloso](http://example.com/book.html)- John Doe
CORRECTO : * [Un libro sencillamente fabuloso](http://example.com/book.html) - John Doe CORRECTO : * [Un libro sencillamente fabuloso](http://example.com/book.html) - John Doe
``` ```
- Ponga un solo espacio entre el enlace al contenido y su formato: - Ponga un solo espacio entre el enlace al contenido y su formato:
``` ```text
INCORRECTO : * [Un libro muy interesante](https://example.org/book.pdf)(PDF) INCORRECTO: * [Un libro muy interesante](https://example.org/book.pdf)(PDF)
CORRECTO : * [Un libro muy interesante](https://example.org/book.pdf) (PDF) CORRECTO : * [Un libro muy interesante](https://example.org/book.pdf) (PDF)
``` ```
- El autor se antepone al formato: - El autor se antepone al formato:
``` ```text
INCORRECTO : * [Un libro muy interesante](https://example.org/book.pdf)- (PDF) Jane Roe INCORRECTO: * [Un libro muy interesante](https://example.org/book.pdf)- (PDF) Jane Roe
CORRECTO : * [Un libro muy interesante](https://example.org/book.pdf) - Jane Roe (PDF) CORRECTO : * [Un libro muy interesante](https://example.org/book.pdf) - Jane Roe (PDF)
``` ```
- Múltiples formatos: - Múltiples formatos:
``` ```text
INCORRECTO : * [Otro libro interesante](http://example.com/) - John Doe (HTML) INCORRECTO: * [Otro libro interesante](http://example.com/) - John Doe (HTML)
INCORRECTO : * [Otro libro interesante](https://downloads.example.org/book.html) - John Doe (sitio de descarga) INCORRECTO: * [Otro libro interesante](https://downloads.example.org/book.html) - John Doe (sitio de descarga)
CORRECTO : * [Otro libro interesante](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) CORRECTO : * [Otro libro interesante](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- Incluya el año de publicación como parte del título de los libros más antiguos: - Incluya el año de publicación como parte del título de los libros más antiguos:
``` ```text
INCORRECTO : * [Un libro bastante especial](https://example.org/book.html) - Jane Roe - 1970 INCORRECTO: * [Un libro bastante especial](https://example.org/book.html) - Jane Roe - 1970
CORRECTO : * [Un libro bastante especial (1970)](https://example.org/book.html) - Jane Roe CORRECTO : * [Un libro bastante especial (1970)](https://example.org/book.html) - Jane Roe
``` ```
- <a name="in_process"></a>Libros en proceso / no acabados aún: - <a name="in_process"></a>Libros en proceso / no acabados aún:
``` ```text
CORRECTO: * [A punto de ser un libro fascinante](http://example.com/book2.html) - John Doe (HTML) (:construction: *en proceso*) CORRECTO : * [A punto de ser un libro fascinante](http://example.com/book2.html) - John Doe (HTML) (:construction: *en proceso*)
``` ```
- <a name="archived"></a>Enlaces archivados: - <a name="archived"></a>Enlaces archivados:
``` ```text
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)* 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)*
``` ```
<a name="notes"></a> <a name="notes"></a>
@ -252,8 +254,8 @@ Si es posible imprimirlo y conservar su esencia, no es un Tutorial Interactivo.
- La validación de URLs se realiza mediante [awesome_bot](https://github.com/dkhamsing/awesome_bot) - La validación de URLs se realiza mediante [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- Para activar esta validación de URL, envíe un commit que incluya como mensaje de confirmación `check_urls=fichero_a_comprobar`: - Para activar esta validación de URL, envíe un commit que incluya como mensaje de confirmación `check_urls=fichero_a_comprobar`:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-es.md
``` ```
- Es posible especificar más de un fichero a comprobar. Simplemente use un espacio para separar cada entrada. - Es posible especificar más de un fichero a comprobar. Simplemente use un espacio para separar cada entrada.

View File

@ -75,63 +75,65 @@
مثال: مثال:
[...] ```text
* [یک کتاب عالی](http://example.com/example.html) [...]
(خط خالی) * [یک کتاب عالی](http://example.com/example.html)
(خط خالی) (خط خالی)
### مثال (خط خالی)
(خط خالی) ### مثال
* [یک کتاب عالی دیگر](http://example.com/book.html) (خط خالی)
* [یک کتاب دیگر](http://example.com/other.html) * [یک کتاب عالی دیگر](http://example.com/book.html)
* [یک کتاب دیگر](http://example.com/other.html)
```
* بین `]` و `(` space نگذارید: * بین `]` و `(` space نگذارید:
``` ```text
بد : * [یک کتاب عالی دیگر] (http://example.com/book.html) بد : * [یک کتاب عالی دیگر] (http://example.com/book.html)
خوب: * [یک کتاب عالی دیگر](http://example.com/book.html) خوب: * [یک کتاب عالی دیگر](http://example.com/book.html)
``` ```
* اگر اسم نویسنده را اضافه می‌کنید، از ` - ` استفاده کنید (یک dash با دو single space): * اگر اسم نویسنده را اضافه می‌کنید، از ` - ` استفاده کنید (یک dash با دو single space):
``` ```text
بد : * [یک کتاب عالی دیگر](http://example.com/book.html)- نام نویسنده بد : * [یک کتاب عالی دیگر](http://example.com/book.html)- نام نویسنده
خوب: * [یک کتاب عالی دیگر](http://example.com/book.html) - نام نویسنده خوب: * [یک کتاب عالی دیگر](http://example.com/book.html) - نام نویسنده
``` ```
* یک single space بین لینک و فرمت قرار دهید: * یک single space بین لینک و فرمت قرار دهید:
``` ```text
بد : * [یک کتاب خیلی عالی](https://example.org/book.pdf)(PDF) بد : * [یک کتاب خیلی عالی](https://example.org/book.pdf)(PDF)
خوب: * [یک کتاب خیلی عالی](https://example.org/book.pdf) (PDF) خوب: * [یک کتاب خیلی عالی](https://example.org/book.pdf) (PDF)
``` ```
* نویسنده قبل از فرمت می‌آید: * نویسنده قبل از فرمت می‌آید:
``` ```text
بد : * [یک کتاب خیلی عالی](https://example.org/book.pdf)- (PDF) نام نویسنده بد : * [یک کتاب خیلی عالی](https://example.org/book.pdf)- (PDF) نام نویسنده
خوب: * [یک کتاب خیلی عالی](https://example.org/book.pdf) - یک نویسنده دیگر (PDF) خوب: * [یک کتاب خیلی عالی](https://example.org/book.pdf) - یک نویسنده دیگر (PDF)
``` ```
* چند فرمتی‌ها: * چند فرمتی‌ها:
``` ```text
بد : * [یک کتاب عالی دیگر](http://example.com/)- نام نویسنده (HTML) بد : * [یک کتاب عالی دیگر](http://example.com/)- نام نویسنده (HTML)
بد : * [یک کتاب عالی دیگر](https://downloads.example.org/book.html)- نام نویسنده (download site) بد : * [یک کتاب عالی دیگر](https://downloads.example.org/book.html)- نام نویسنده (download site)
خوب: * [یک کتاب عالی دیگر](http://example.com/) - نام نویسنده (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) خوب: * [یک کتاب عالی دیگر](http://example.com/) - نام نویسنده (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
* سال انتشار برای کتاب‌های قدیمی را در عنوان ینویسید: * سال انتشار برای کتاب‌های قدیمی را در عنوان ینویسید:
``` ```text
بد : * [یک کتاب خیلی عالی](https://example.org/book.html) - نام نویسنده - 1970 بد : * [یک کتاب خیلی عالی](https://example.org/book.html) - نام نویسنده - 1970
خوب: * [یک کتاب خیلی عالی (1970)](https://example.org/book.html) - نام نویسنده خوب: * [یک کتاب خیلی عالی (1970)](https://example.org/book.html) - نام نویسنده
``` ```
* <a name="in_process"></a>کتاب‌های در دست تالیف: * <a name="in_process"></a>کتاب‌های در دست تالیف:
``` ```text
خوب: * [کتابی که عالی خواهدشد](http://example.com/book2.html) - نام نویسنده (HTML) (:construction: *in process*) خوب: * [کتابی که عالی خواهدشد](http://example.com/book2.html) - نام نویسنده (HTML) (:construction: *in process*)
``` ```
### خودکارسازی ### خودکارسازی
@ -140,9 +142,9 @@
* اعتبارسنجی لینک‌ها با استفاده از [awesome_bot](https://github.com/dkhamsing/awesome_bot) انجام می‌شود. * اعتبارسنجی لینک‌ها با استفاده از [awesome_bot](https://github.com/dkhamsing/awesome_bot) انجام می‌شود.
* برای اجرای اعتبارسنجی لینک‌ها، کامیتی پوش کنید که در بدنه‌ی آن `check_urls=file_to_check` نوشته شده باشد: * برای اجرای اعتبارسنجی لینک‌ها، کامیتی پوش کنید که در بدنه‌ی آن `check_urls=file_to_check` نوشته شده باشد:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-fa_IR.md
``` ```
* با استفاده از single space برای جدا کردن هر ورودی، می‌توانید بیشتر از یک فایل را برای بررسی مشخص کنید. * با استفاده از single space برای جدا کردن هر ورودی، می‌توانید بیشتر از یک فایل را برای بررسی مشخص کنید.
* اگر بیش از یک فایل را مشخص کردید، نتایج بیلد بر اساس نتیجه آخرین فایل بررسی‌شده خواهد بود. دقت کنید که ممکن است به همین علت، نتیجه سبز را ببینید. پس برای اطمینان لاگ بیلد را با کلیک روی "Show all checks" -> "Details" در پایان پول ریکوئست ببینید. * اگر بیش از یک فایل را مشخص کردید، نتایج بیلد بر اساس نتیجه آخرین فایل بررسی‌شده خواهد بود. دقت کنید که ممکن است به همین علت، نتیجه سبز را ببینید. پس برای اطمینان لاگ بیلد را با کلیک روی "Show all checks" -> "Details" در پایان پول ریکوئست ببینید.

View File

@ -76,69 +76,71 @@ The idea is to have:
Halimbawa: Halimbawa:
[...] ```text
* [An Awesome Book](http://example.com/example.html) [...]
(blank line) * [An Awesome Book](http://example.com/example.html)
(blank line) (blank line)
### Example (blank line)
(blank line) ### Example
* [Another Awesome Book](http://example.com/book.html) (blank line)
* [Some Other Book](http://example.com/other.html) * [Another Awesome Book](http://example.com/book.html)
* [Some Other Book](http://example.com/other.html)
```
- Huwag maglagay ng mga puwang sa pagitan `]` at `(`: - Huwag maglagay ng mga puwang sa pagitan `]` at `(`:
``` ```text
BAD : * [Another Awesome Book] (http://example.com/book.html) BAD : * [Another Awesome Book] (http://example.com/book.html)
GOOD: * [Another Awesome Book](http://example.com/book.html) GOOD: * [Another Awesome Book](http://example.com/book.html)
``` ```
- Kung isasama mo ang may-akda, gamitin ` - ` (isang gitling na napapalibutan ng mga solong espasyo): - Kung isasama mo ang may-akda, gamitin ` - ` (isang gitling na napapalibutan ng mga solong espasyo):
``` ```text
BAD : * [Another Awesome Book](http://example.com/book.html)- John Doe BAD : * [Another Awesome Book](http://example.com/book.html)- John Doe
GOOD: * [Another Awesome Book](http://example.com/book.html) - John Doe GOOD: * [Another Awesome Book](http://example.com/book.html) - John Doe
``` ```
- Maglagay ng isang puwang sa pagitan ng link at ang format nito: - Maglagay ng isang puwang sa pagitan ng link at ang format nito:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.pdf)(PDF) BAD : * [A Very Awesome Book](https://example.org/book.pdf)(PDF)
GOOD: * [A Very Awesome Book](https://example.org/book.pdf) (PDF) GOOD: * [A Very Awesome Book](https://example.org/book.pdf) (PDF)
``` ```
- Nauna ang may-akda sa format: - Nauna ang may-akda sa format:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.pdf)- (PDF) Jane Roe BAD : * [A Very Awesome Book](https://example.org/book.pdf)- (PDF) Jane Roe
GOOD: * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF) GOOD: * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF)
``` ```
- Maramihang format: - Maramihang format:
``` ```text
BAD : * [Another Awesome Book](http://example.com/)- John Doe (HTML) BAD : * [Another Awesome Book](http://example.com/)- John Doe (HTML)
BAD : * [Another Awesome Book](https://downloads.example.org/book.html)- John Doe (download site) BAD : * [Another Awesome Book](https://downloads.example.org/book.html)- John Doe (download site)
GOOD: * [Another Awesome Book](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) GOOD: * [Another Awesome Book](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- Isama ang taon ng publikasyon sa pamagat para sa mga mas lumang aklat: - Isama ang taon ng publikasyon sa pamagat para sa mga mas lumang aklat:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.html) - Jane Roe - 1970 BAD : * [A Very Awesome Book](https://example.org/book.html) - Jane Roe - 1970
GOOD: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe GOOD: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe
``` ```
- <a name="in_process"></a>In-process books: - <a name="in_process"></a>In-process books:
``` ```text
GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*) GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
``` ```
- <a name="archived"></a>Archived link: - <a name="archived"></a>Archived link:
``` ```text
GOOD: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)* GOOD: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
``` ```
### Mga Tala ### Mga Tala
@ -237,9 +239,9 @@ Kung maaari mong i-print ito at panatilihin ang kakanyahan nito, hindi ito isang
- Gumagamit ng pagpapatunay ng URL [awesome_bot](https://github.com/dkhamsing/awesome_bot) - Gumagamit ng pagpapatunay ng URL [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- Upang ma-trigger ang pagpapatunay ng URL, mag-push ng commit na may kasamang commit na mensahe na naglalaman `check_urls=file_to_check`: - Upang ma-trigger ang pagpapatunay ng URL, mag-push ng commit na may kasamang commit na mensahe na naglalaman `check_urls=file_to_check`:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-fil.md
``` ```
- Maaari kang tumukoy ng higit sa isang file na susuriin, gamit ang isang puwang upang paghiwalayin ang bawat entry. - Maaari kang tumukoy ng higit sa isang file na susuriin, gamit ang isang puwang upang paghiwalayin ang bawat entry.
- Kung tumukoy ka ng higit sa isang file, ang mga resulta ng build ay batay sa resulta ng huling file na nasuri. Dapat mong malaman na maaari kang makapasa sa mga berdeng build dahil dito kaya siguraduhing suriin ang build log sa dulo ng pull request sa pamamagitan ng pag-click sa "Show all checks" -> "Details". - Kung tumukoy ka ng higit sa isang file, ang mga resulta ng build ay batay sa resulta ng huling file na nasuri. Dapat mong malaman na maaari kang makapasa sa mga berdeng build dahil dito kaya siguraduhing suriin ang build log sa dulo ng pull request sa pamamagitan ng pag-click sa "Show all checks" -> "Details".

View File

@ -73,63 +73,65 @@ l'idée est d'avoir:
Exemple: Exemple:
[...] ```text
* [Un Livre Génial](http://exemple.com/exemple.html) [...]
(ligne blanche) * [Un Livre Génial](http://exemple.com/exemple.html)
(ligne blanche) (ligne blanche)
### Exemple (ligne blanche)
(ligne blanche) ### Exemple
* [Un Autre Livre Génial](http://exemple.com/livre.html) (ligne blanche)
* [Un Autre Livre](http://exemple.com/autre.html) * [Un Autre Livre Génial](http://exemple.com/livre.html)
* [Un Autre Livre](http://exemple.com/autre.html)
```
- Mettez pas des espaces entre `]` et `(`: - Mettez pas des espaces entre `]` et `(`:
``` ```text
MAUVAIS : * [Un Autre Livre Génial] (http://exemple.com/livre.html) MAUVAIS: * [Un Autre Livre Génial] (http://exemple.com/livre.html)
BIEN : * [Un Autre Livre Génial](http://exemple.com/livre.html) BIEN : * [Un Autre Livre Génial](http://exemple.com/livre.html)
``` ```
- Si vous incluez l'auteur, utilisez ` - ` (un tiret entouré d'un espaces): - Si vous incluez l'auteur, utilisez ` - ` (un tiret entouré d'un espaces):
``` ```text
MAUVAIS : * [Un Autre Livre Génial](http://exemple.com/livre.html)- John Doe MAUVAIS: * [Un Autre Livre Génial](http://exemple.com/livre.html)- John Doe
BIEN : * [Un Autre Livre Génial](http://exemple.com/livre.html) - John Doe BIEN : * [Un Autre Livre Génial](http://exemple.com/livre.html) - John Doe
``` ```
- Mettez un seul espace entre le lien et son format: - Mettez un seul espace entre le lien et son format:
``` ```text
MAUVAIS : * [Un Autre Livre Génial](https://exemple.org/livre.pdf)(PDF) MAUVAIS: * [Un Autre Livre Génial](https://exemple.org/livre.pdf)(PDF)
BIEN : * [Un Autre Livre Génial](https://exemple.org/livre.pdf) (PDF) BIEN : * [Un Autre Livre Génial](https://exemple.org/livre.pdf) (PDF)
``` ```
- L'auteur vient avant le format: - L'auteur vient avant le format:
``` ```text
MAUVAIS : * [Un Autre Livre Génial](https://exemple.org/livre.pdf)- (PDF) Jane Roe MAUVAIS: * [Un Autre Livre Génial](https://exemple.org/livre.pdf)- (PDF) Jane Roe
BIEN : * [Un Autre Livre Génial](https://exemple.org/livre.pdf) - Jane Roe (PDF) BIEN : * [Un Autre Livre Génial](https://exemple.org/livre.pdf) - Jane Roe (PDF)
``` ```
- Formats multiples: - Formats multiples:
``` ```text
MAUVAIS : * [Un Autre Livre Génial](http://exemple.com/)- John Doe (HTML) MAUVAIS: * [Un Autre Livre Génial](http://exemple.com/)- John Doe (HTML)
MAUVAIS : * [Un Autre Livre Génial](https://downloads.exemple.org/livre.html)- John Doe (site de téléchargement) MAUVAIS: * [Un Autre Livre Génial](https://downloads.exemple.org/livre.html)- John Doe (site de téléchargement)
BIEN : * [Un Autre Livre Génial](http://exemple.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.exemple.org/livre.html) BIEN : * [Un Autre Livre Génial](http://exemple.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.exemple.org/livre.html)
``` ```
- Inclure l'année de publication dans le titre pour les livres plus anciens : - Inclure l'année de publication dans le titre pour les livres plus anciens :
``` ```text
MAUVAIS : * [Un Autre Livre Génial](https://exemple.org/livre.html) - Jane Roe - 1970 MAUVAIS: * [Un Autre Livre Génial](https://exemple.org/livre.html) - Jane Roe - 1970
BIEN : * [Un Autre Livre Génial (1970)](https://exemple.org/livre.html) - Jane Roe BIEN : * [Un Autre Livre Génial (1970)](https://exemple.org/livre.html) - Jane Roe
``` ```
- <a name="in_process"></a>Livres en cours : - <a name="in_process"></a>Livres en cours :
``` ```
BIEN : * [Sera bientôt un livre génial](http://exemple.com/livre2.html) - John Doe (HTML) (:construction: *in process*) BIEN : * [Sera bientôt un livre génial](http://exemple.com/livre2.html) - John Doe (HTML) (:construction: *in process*)
``` ```
### Remarques ### Remarques
@ -228,9 +230,9 @@ Si vous pouvez l'imprimer et conserver son essence, ce n'est pas un didacticiel
- La validation d'URL utilise [awesome_bot](https://github.com/dkhamsing/awesome_bot) - La validation d'URL utilise [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- Pour déclencher la validation d'URL, poussez un commit qui inclut un message de commit contenant `check_urls=file_to_check` : - Pour déclencher la validation d'URL, poussez un commit qui inclut un message de commit contenant `check_urls=file_to_check` :
``` ```properties
check_urls=free-programming-livres.md free-programming-livres-en.md check_urls=free-programming-books.md free-programming-books-fr.md
``` ```
- Vous pouvez spécifier plus d'un fichier à vérifier, en utilisant un seul espace pour séparer chaque entrée - Vous pouvez spécifier plus d'un fichier à vérifier, en utilisant un seul espace pour séparer chaque entrée
- Si vous spécifiez plus d'un fichier, les résultats de la construction sont basés sur le résultat du dernier fichier vérifié. Vous devez savoir que vous pouvez obtenir des versions vertes de réussite à cause de cela, alors assurez-vous d'inspecter le journal de construction à la fin de la demande d'extraction en cliquant sur "Show all checks" -> "Details". - Si vous spécifiez plus d'un fichier, les résultats de la construction sont basés sur le résultat du dernier fichier vérifié. Vous devez savoir que vous pouvez obtenir des versions vertes de réussite à cause de cela, alors assurez-vous d'inspecter le journal de construction à la fin de la demande d'extraction en cliquant sur "Show all checks" -> "Details".

View File

@ -76,69 +76,71 @@ L'idea è di avere:
Esempi: Esempi:
[...] ```text
* [An Awesome Book](http://example.com/example.html) [...]
(linea vuota) * [An Awesome Book](http://example.com/example.html)
(linea vuota) (linea vuota)
### Esempio (linea vuota)
(linea vuota) ### Esempio
* [Another Awesome Book](http://example.com/book.html) (linea vuota)
* [Some Other Book](http://example.com/other.html) * [Another Awesome Book](http://example.com/book.html)
* [Some Other Book](http://example.com/other.html)
```
- Non mettere uno spazio tra `]` e `(`: - Non mettere uno spazio tra `]` e `(`:
``` ```text
SCORRETTO : * [Another Awesome Book] (http://example.com/book.html) SCORRETTO: * [Another Awesome Book] (http://example.com/book.html)
CORRETTO: * [Another Awesome Book](http://example.com/book.html) CORRETTO : * [Another Awesome Book](http://example.com/book.html)
``` ```
- Se includi gli autori, usa ` - ` (un trattino circondato da spazi singoli): - Se includi gli autori, usa ` - ` (un trattino circondato da spazi singoli):
``` ```text
SCORRETTO : * [Another Awesome Book](http://example.com/book.html)- John Doe SCORRETTO: * [Another Awesome Book](http://example.com/book.html)- John Doe
CORRETTO: * [Another Awesome Book](http://example.com/book.html) - John Doe CORRETTO : * [Another Awesome Book](http://example.com/book.html) - John Doe
``` ```
- Metti uno spazio tra il link e il formato: - Metti uno spazio tra il link e il formato:
``` ```text
SCORRETTO : * [A Very Awesome Book](https://example.org/book.pdf)(PDF) SCORRETTO: * [A Very Awesome Book](https://example.org/book.pdf)(PDF)
CORRETTO: * [A Very Awesome Book](https://example.org/book.pdf) (PDF) CORRETTO : * [A Very Awesome Book](https://example.org/book.pdf) (PDF)
``` ```
- Gli autori vanno prima del formato: - Gli autori vanno prima del formato:
``` ```text
SCORRETTO : * [A Very Awesome Book](https://example.org/book.pdf)- (PDF) Jane Roe SCORRETTO: * [A Very Awesome Book](https://example.org/book.pdf)- (PDF) Jane Roe
CORRETTO: * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF) CORRETTO : * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF)
``` ```
- Formati multipli: - Formati multipli:
``` ```text
SCORRETTO : * [Another Awesome Book](http://example.com/)- John Doe (HTML) SCORRETTO: * [Another Awesome Book](http://example.com/)- John Doe (HTML)
SCORRETTO : * [Another Awesome Book](https://downloads.example.org/book.html)- John Doe (download site) SCORRETTO: * [Another Awesome Book](https://downloads.example.org/book.html)- John Doe (download site)
CORRETTO: * [Another Awesome Book](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) CORRETTO : * [Another Awesome Book](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- Includi l'anno di pubblicazione nel titolo per i libri più vecchi: - Includi l'anno di pubblicazione nel titolo per i libri più vecchi:
``` ```text
SCORRETTO : * [A Very Awesome Book](https://example.org/book.html) - Jane Roe - 1970 SCORRETTO: * [A Very Awesome Book](https://example.org/book.html) - Jane Roe - 1970
CORRETTO: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe CORRETTO : * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe
``` ```
- <a name="in_process"></a>Libri in sviluppo: - <a name="in_process"></a>Libri in sviluppo:
``` ```text
CORRETTO: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*) CORRETTO : * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
``` ```
- <a name="archived"></a>Link archiviato: - <a name="archived"></a>Link archiviato:
``` ```text
CORRETTO: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)* CORRETTO : * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
``` ```
### Note ### Note
@ -237,9 +239,9 @@ Se riesci a stamparlo e conservarne l'essenza, non è un tutorial interattivo.
- La validazione dell'URL usa [awesome_bot](https://github.com/dkhamsing/awesome_bot) - La validazione dell'URL usa [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- Per attivare la convalida dell'URL, invia un commit che includa un messaggio di commit contenente `check_urls=file_to_check`: - Per attivare la convalida dell'URL, invia un commit che includa un messaggio di commit contenente `check_urls=file_to_check`:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-it.md
``` ```
- È possibile specificare più di un file da controllare, utilizzando un singolo spazio per separare ogni voce. - È possibile specificare più di un file da controllare, utilizzando un singolo spazio per separare ogni voce.
- Se specifichi più di un file, i risultati della build si basano sul risultato dell'ultimo file controllato. Dovresti essere consapevole che potresti ottenere il passaggio di build verdi a causa di ciò, quindi assicurati di ispezionare il registro di build alla fine della richiesta pull facendo clic su "Show all checks" -> "Details". - Se specifichi più di un file, i risultati della build si basano sul risultato dell'ultimo file controllato. Dovresti essere consapevole che potresti ottenere il passaggio di build verdi a causa di ciò, quindi assicurati di ispezionare il registro di build alla fine della richiesta pull facendo clic su "Show all checks" -> "Details".

View File

@ -69,63 +69,65 @@
예시: 예시:
[...] ```text
* [An Awesome Book](http://example.com/example.html) [...]
(blank line) * [An Awesome Book](http://example.com/example.html)
(blank line) (blank line)
### Example (blank line)
(blank line) ### Example
* [Another Awesome Book](http://example.com/book.html) (blank line)
* [Some Other Book](http://example.com/other.html) * [Another Awesome Book](http://example.com/book.html)
* [Some Other Book](http://example.com/other.html)
```
- `]``(` 사이에 공백을 넣지 마십시오: - `]``(` 사이에 공백을 넣지 마십시오:
``` ```text
BAD : * [Another Awesome Book] (http://example.com/book.html) BAD : * [Another Awesome Book] (http://example.com/book.html)
GOOD: * [Another Awesome Book](http://example.com/book.html) GOOD: * [Another Awesome Book](http://example.com/book.html)
``` ```
- 저자를 표시할 경우, ` - `를 사용하십시오 (띄어쓰기 - 띄어쓰기): - 저자를 표시할 경우, ` - `를 사용하십시오 (띄어쓰기 - 띄어쓰기):
``` ```text
BAD : * [Another Awesome Book](http://example.com/book.html)- John Doe BAD : * [Another Awesome Book](http://example.com/book.html)- John Doe
GOOD: * [Another Awesome Book](http://example.com/book.html) - John Doe GOOD: * [Another Awesome Book](http://example.com/book.html) - John Doe
``` ```
- 바로가기와 형식 사이에는 공백을 삽입 하십시오: - 바로가기와 형식 사이에는 공백을 삽입 하십시오:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.pdf)(PDF) BAD : * [A Very Awesome Book](https://example.org/book.pdf)(PDF)
GOOD: * [A Very Awesome Book](https://example.org/book.pdf) (PDF) GOOD: * [A Very Awesome Book](https://example.org/book.pdf) (PDF)
``` ```
- 저자는 형식 전에 옵니다: - 저자는 형식 전에 옵니다:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.pdf)- (PDF) Jane Roe BAD : * [A Very Awesome Book](https://example.org/book.pdf)- (PDF) Jane Roe
GOOD: * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF) GOOD: * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF)
``` ```
- 여러가지의 파일 형식이 존재할떄: - 여러가지의 파일 형식이 존재할떄:
``` ```text
BAD : * [Another Awesome Book](http://example.com/)- John Doe (HTML) BAD : * [Another Awesome Book](http://example.com/)- John Doe (HTML)
BAD : * [Another Awesome Book](https://downloads.example.org/book.html)- John Doe (download site) BAD : * [Another Awesome Book](https://downloads.example.org/book.html)- John Doe (download site)
GOOD: * [Another Awesome Book](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) GOOD: * [Another Awesome Book](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- 오래된 책들은 출판 년도를 포함하세요: - 오래된 책들은 출판 년도를 포함하세요:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.html) - Jane Roe - 1970 BAD : * [A Very Awesome Book](https://example.org/book.html) - Jane Roe - 1970
GOOD: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe GOOD: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe
``` ```
- <a name="in_process"></a>작성중인 책: - <a name="in_process"></a>작성중인 책:
``` ```text
GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*) GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
``` ```
### 노트(쪽지) ### 노트(쪽지)
@ -224,9 +226,9 @@ GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe
- 바로가기 주소 검증은 [awesome_bot](https://github.com/dkhamsing/awesome_bot)를 이용합니다 - 바로가기 주소 검증은 [awesome_bot](https://github.com/dkhamsing/awesome_bot)를 이용합니다
- 바로가기 주소 검증을 위해 커밋 메시지에 `check_urls=file_to_check`을 포함해 주세요: - 바로가기 주소 검증을 위해 커밋 메시지에 `check_urls=file_to_check`을 포함해 주세요:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-ko.md
``` ```
- 각 입력을 공백으로 구문하여 하나 이상의 파일을 검사 할 수 있습니다. - 각 입력을 공백으로 구문하여 하나 이상의 파일을 검사 할 수 있습니다.
- 만약 하나 이상의 파일을 검사한다면, 검사 결과는 마지막 파일의 검사 결과가 표시됩니다. 이 특성으로 인하여 통과를 받았더라도 관리자에 의하여 최종 승인이 보류 될 수 있습니다. 정확한 결과를 확인 하려면, "Show all checks" -> "Details"로 가세요. - 만약 하나 이상의 파일을 검사한다면, 검사 결과는 마지막 파일의 검사 결과가 표시됩니다. 이 특성으로 인하여 통과를 받았더라도 관리자에 의하여 최종 승인이 보류 될 수 있습니다. 정확한 결과를 확인 하려면, "Show all checks" -> "Details"로 가세요.

View File

@ -73,63 +73,65 @@ A ideia é ter:
Exemplo: Exemplo:
[...] ```text
* [Um Livro Incrível](http://exemplo.com/exemplo.html) [...]
(linha em branco) * [Um Livro Incrível](http://exemplo.com/exemplo.html)
(linha em branco) (linha em branco)
### Exemplo (linha em branco)
(linha em branco) ### Exemplo
* [Outro Livro Incrível](http://exemplo.com/livro.html) (linha em branco)
* [Outro Livro Qualquer](http://exemplo.com/outro.html) * [Outro Livro Incrível](http://exemplo.com/livro.html)
* [Outro Livro Qualquer](http://exemplo.com/outro.html)
```
- Não coloque espaços entre `]` e `(`: - Não coloque espaços entre `]` e `(`:
``` ```text
RUIM : * [Outro Livro Incrível] (http://exemplo.com/livro.html) RUIM: * [Outro Livro Incrível] (http://exemplo.com/livro.html)
BOM : * [Outro Livro Incrível](http://exemplo.com/livro.html) BOM : * [Outro Livro Incrível](http://exemplo.com/livro.html)
``` ```
- Se incluir o autor, use ` - ` (um traço envolto por espaços simples): - Se incluir o autor, use ` - ` (um traço envolto por espaços simples):
``` ```text
RUIM : * [Outro Livro Incrível](http://exemplo.com/livro.html)- Fulano de Tal RUIM: * [Outro Livro Incrível](http://exemplo.com/livro.html)- Fulano de Tal
BOM : * [Outro Livro Incrível](http://exemplo.com/livro.html) - Fulano de Tal BOM : * [Outro Livro Incrível](http://exemplo.com/livro.html) - Fulano de Tal
``` ```
- Coloque um espaço simples entre o _link_ e seu formato: - Coloque um espaço simples entre o _link_ e seu formato:
``` ```text
RUIM : * [Um Livro Muito Incrível](https://exemplo.org/livro.pdf)(PDF) RUIM: * [Um Livro Muito Incrível](https://exemplo.org/livro.pdf)(PDF)
BOM : * [Um Livro Muito Incrível](https://exemplo.org/livro.pdf) (PDF) BOM : * [Um Livro Muito Incrível](https://exemplo.org/livro.pdf) (PDF)
``` ```
- Autor vem antes do formato: - Autor vem antes do formato:
``` ```text
RUIM : * [Um Livro Muito Incrível](https://exemplo.org/livro.pdf)- (PDF) Fulana de Tal RUIM: * [Um Livro Muito Incrível](https://exemplo.org/livro.pdf)- (PDF) Fulana de Tal
BOM : * [Um Livro Muito Incrível](https://exemplo.org/livro.pdf) - Fulana de Tal (PDF) BOM : * [Um Livro Muito Incrível](https://exemplo.org/livro.pdf) - Fulana de Tal (PDF)
``` ```
- Múltiplos formatos: - Múltiplos formatos:
``` ```text
RUIM : * [Outro Livro Incrível](http://exemplo.com/)- Fulano de Tal (HTML) RUIM: * [Outro Livro Incrível](http://exemplo.com/)- Fulano de Tal (HTML)
RUIM : * [Outro Livro Incrível](https://downloads.exemplo.org/livro.html)- Fulano de Tal (download site) RUIM: * [Outro Livro Incrível](https://downloads.exemplo.org/livro.html)- Fulano de Tal (download site)
BOM : * [Outro Livro Incrível](http://exemplo.com/) - Fulano de Tal (HTML) [(PDF, EPUB)](https://downloads.exemplo.org/livro.html) BOM : * [Outro Livro Incrível](http://exemplo.com/) - Fulano de Tal (HTML) [(PDF, EPUB)](https://downloads.exemplo.org/livro.html)
``` ```
- Inclua o ano de publicação no título de livros antigos: - Inclua o ano de publicação no título de livros antigos:
``` ```text
RUIM : * [Um Livro Muito Incrível](https://exemplo.org/livro.html) - Fulana de Tal - 1970 RUIM: * [Um Livro Muito Incrível](https://exemplo.org/livro.html) - Fulana de Tal - 1970
BOM : * [Um Livro Muito Incrível (1970)](https://exemplo.org/livro.html) - Fulana de Tal BOM : * [Um Livro Muito Incrível (1970)](https://exemplo.org/livro.html) - Fulana de Tal
``` ```
- <a name="in_process"></a>Livros em processo: - <a name="in_process"></a>Livros em processo:
``` ```text
BOM : * [Será Um Livro Incrível Em Breve](http://exemplo.com/livro2.html) - Fulano de Tal (HTML) (:construction: *em processo*) BOM : * [Será Um Livro Incrível Em Breve](http://exemplo.com/livro2.html) - Fulano de Tal (HTML) (:construction: *em processo*)
``` ```
### Observações ### Observações
@ -228,9 +230,9 @@ Se você pode capturar a tela ou imprimí-la e reter sua essência, então não
- Validação de URL usa [awesome_bot](https://github.com/dkhamsing/awesome_bot) - Validação de URL usa [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- Para ativar a validação de URL, dê _push_ num _commit_ que inclua uma mensagem de _commit_ contendo `check_urls=file_to_check`: - Para ativar a validação de URL, dê _push_ num _commit_ que inclua uma mensagem de _commit_ contendo `check_urls=file_to_check`:
``` ```properties
check_urls=free-programming-books.md free-programming-books-pt_BR.md check_urls=free-programming-books.md free-programming-books-pt_BR.md
``` ```
- Você pode especificar mais de um arquivo para checagem, usando um espaço simples para separar cada entrada. - Você pode especificar mais de um arquivo para checagem, usando um espaço simples para separar cada entrada.
- Se você especificar mais de um arquivo, os resultados de _build_ serão baseados no resultado do último arquivo verificado. Você deve se atentar para o fato de que pode obter um _build_ com verde de sucesso devido a isso. Então, certifique-se de inspecionar o _build log_ ao final de cada _pull request_ clicando em "Show all checks" -> "Details". - Se você especificar mais de um arquivo, os resultados de _build_ serão baseados no resultado do último arquivo verificado. Você deve se atentar para o fato de que pode obter um _build_ com verde de sucesso devido a isso. Então, certifique-se de inspecionar o _build log_ ao final de cada _pull request_ clicando em "Show all checks" -> "Details".

View File

@ -78,63 +78,65 @@
Пример: Пример:
[...] ```text
* [Шикарная книга](http://example.com/example.html) [...]
(пустая строка) * [Шикарная книга](http://example.com/example.html)
(пустая строка) (пустая строка)
### Пример (пустая строка)
(пустая строка) ### Пример
* [Другая шикарная книга](http://example.com/book.html) (пустая строка)
* [Ещё одна другая книга](http://example.com/other.html) * [Другая шикарная книга](http://example.com/book.html)
* [Ещё одна другая книга](http://example.com/other.html)
```
- Не вставляйте пробел между `]` и `(`: - Не вставляйте пробел между `]` и `(`:
``` ```text
ПЛОХО : * [Другая шикарная книга] (http://example.com/book.html) ПЛОХО : * [Другая шикарная книга] (http://example.com/book.html)
ХОРОШО: * [Другая шикарная книга](http://example.com/book.html) ХОРОШО: * [Другая шикарная книга](http://example.com/book.html)
``` ```
- Если вы указываете автора, используйте ` - ` (тире, окруженное одиночными пробелами): - Если вы указываете автора, используйте ` - ` (тире, окруженное одиночными пробелами):
``` ```text
ПЛОХО : * [Другая шикарная книга](http://example.com/book.html)- Джон Доу ПЛОХО : * [Другая шикарная книга](http://example.com/book.html)- Джон Доу
ХОРОШО: * [Другая шикарная книга](http://example.com/book.html) - Джон Доу ХОРОШО: * [Другая шикарная книга](http://example.com/book.html) - Джон Доу
``` ```
- Отбейте ссылку и её формат пробелом: - Отбейте ссылку и её формат пробелом:
``` ```text
ПЛОХО : * [Очень хорошая книга](https://example.org/book.pdf)(PDF) ПЛОХО : * [Очень хорошая книга](https://example.org/book.pdf)(PDF)
ХОРОШО: * [Очень хорошая книга](https://example.org/book.pdf) (PDF) ХОРОШО: * [Очень хорошая книга](https://example.org/book.pdf) (PDF)
``` ```
- Сперва автор, потом формат: - Сперва автор, потом формат:
``` ```text
ПЛОХО : * [Очень хорошая книга](https://example.org/book.pdf)- (PDF) Джейн Роу ПЛОХО : * [Очень хорошая книга](https://example.org/book.pdf)- (PDF) Джейн Роу
ХОРОШО: * [Очень хорошая книга](https://example.org/book.pdf) - Джейн Роу (PDF) ХОРОШО: * [Очень хорошая книга](https://example.org/book.pdf) - Джейн Роу (PDF)
``` ```
- Несколько форматов: - Несколько форматов:
``` ```text
ПЛОХО : * [Другая шикарная книга](http://example.com/)- Джон Доу (HTML) ПЛОХО : * [Другая шикарная книга](http://example.com/)- Джон Доу (HTML)
ПЛОХО : * [Другая шикарная книга](https://downloads.example.org/book.html)- Джон Доу (cайт для загрузки) ПЛОХО : * [Другая шикарная книга](https://downloads.example.org/book.html)- Джон Доу (cайт для загрузки)
ХОРОШО: * [Другая шикарная книга](http://example.com/) - Джон Доу (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) ХОРОШО: * [Другая шикарная книга](http://example.com/) - Джон Доу (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- Включите год публикации в заголовок для старых книг: - Включите год публикации в заголовок для старых книг:
``` ```text
ПЛОХО : * [Очень хорошая книга](https://example.org/book.html) - Джейн Роу - 1970 ПЛОХО : * [Очень хорошая книга](https://example.org/book.html) - Джейн Роу - 1970
ХОРОШО: * [Очень хорошая книга (1970)](https://example.org/book.html) - Джейн Роу ХОРОШО: * [Очень хорошая книга (1970)](https://example.org/book.html) - Джейн Роу
``` ```
- <a name="in_process"></a>Незавершенные книги: - <a name="in_process"></a>Незавершенные книги:
``` ```text
ХОРОШО: * [Скоро будет отличная книга](http://example.com/book2.html) - Джон Доу (HTML) (:construction: *in process*) ХОРОШО: * [Скоро будет отличная книга](http://example.com/book2.html) - Джон Доу (HTML) (:construction: *in process*)
``` ```
<a name="notes"></a> <a name="notes"></a>
@ -245,9 +247,9 @@
- Для проверки URL используется [awesome_bot](https://github.com/dkhamsing/awesome_bot) - Для проверки URL используется [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- Чтобы запустить проверку URL, нажмите фиксацию, которая включает сообщение фиксации, содержащее `check_urls = ссылка_для_проверки`: - Чтобы запустить проверку URL, нажмите фиксацию, которая включает сообщение фиксации, содержащее `check_urls = ссылка_для_проверки`:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-ru.md
``` ```
- Вы можете указать более одного файла для проверки, используя один пробел для разделения каждой записи. - Вы можете указать более одного файла для проверки, используя один пробел для разделения каждой записи.
- Если вы укажете более одного файла, результаты сборки будут основаны на результате последнего проверенного файла. Вы должны знать, что из-за этого вы можете получить проходящие зеленые сборки, поэтому обязательно проверьте журнал сборки в конце пулреквеста, нажав "Show all checks" -> "Details". - Если вы укажете более одного файла, результаты сборки будут основаны на результате последнего проверенного файла. Вы должны знать, что из-за этого вы можете получить проходящие зеленые сборки, поэтому обязательно проверьте журнал сборки в конце пулреквеста, нажав "Show all checks" -> "Details".

View File

@ -83,63 +83,65 @@ Bằng cách đóng góp, bạn đồng ý tôn trọng [Quy Tắc Ứng Xử](h
Ví dụ: Ví dụ:
[...] ```text
* [Một cuốn sách tuyệt vời](http://example.com/example.html) [...]
(dòng trống) * [Một cuốn sách tuyệt vời](http://example.com/example.html)
(dòng trống) (dòng trống)
### Ví dụ (dòng trống)
(dòng trống) ### Ví dụ
* [Một cuốn sách tuyệt vời khác](http://example.com/book.html) (dòng trống)
* [Một số sách khác](http://example.com/other.html) * [Một cuốn sách tuyệt vời khác](http://example.com/book.html)
* [Một số sách khác](http://example.com/other.html)
```
- Không đặt dấu cách giữa `]``(`: - Không đặt dấu cách giữa `]``(`:
``` ```text
Tệ : * [Một cuốn sách tuyệt vời khác] (http://example.com/book.html) TỆ : * [Một cuốn sách tuyệt vời khác] (http://example.com/book.html)
Tốt: * [Một cuốn sách tuyệt vời khác](http://example.com/book.html) TỐT: * [Một cuốn sách tuyệt vời khác](http://example.com/book.html)
``` ```
- Nếu bao gồm tác giả, hãy sử dụng ` - ` (dấu gạch ngang được bao quanh bởi các khoảng trắng): - Nếu bao gồm tác giả, hãy sử dụng ` - ` (dấu gạch ngang được bao quanh bởi các khoảng trắng):
``` ```text
Tệ : * [Một cuốn sách tuyệt vời khác](http://example.com/book.html)- John Doe TỆ : * [Một cuốn sách tuyệt vời khác](http://example.com/book.html)- John Doe
Tốt: * [Một cuốn sách tuyệt vời khác](http://example.com/book.html) - John Doe TỐT: * [Một cuốn sách tuyệt vời khác](http://example.com/book.html) - John Doe
``` ```
- Đặt một khoảng trắng giữa liên kết và định dạng của nó: - Đặt một khoảng trắng giữa liên kết và định dạng của nó:
``` ```text
Tệ : * [Một cuốn sách rất tuyệt vời](https://example.org/book.pdf)(PDF) TỆ : * [Một cuốn sách rất tuyệt vời](https://example.org/book.pdf)(PDF)
Tốt: * [Một cuốn sách rất tuyệt vời](https://example.org/book.pdf) (PDF) TỐT: * [Một cuốn sách rất tuyệt vời](https://example.org/book.pdf) (PDF)
``` ```
- Tác giả đặt trước định dạng: - Tác giả đặt trước định dạng:
``` ```text
Tệ : * [Một cuốn sách rất tuyệt vời](https://example.org/book.pdf)- (PDF) Jane Roe TỆ : * [Một cuốn sách rất tuyệt vời](https://example.org/book.pdf)- (PDF) Jane Roe
Tốt: * [Một cuốn sách rất tuyệt vời](https://example.org/book.pdf) - Jane Roe (PDF) TỐT: * [Một cuốn sách rất tuyệt vời](https://example.org/book.pdf) - Jane Roe (PDF)
``` ```
- Nhiều định dạng: - Nhiều định dạng:
``` ```text
Tệ : * [Một cuốn sách tuyệt vời khác](http://example.com/)- John Doe (HTML) TỆ : * [Một cuốn sách tuyệt vời khác](http://example.com/)- John Doe (HTML)
Tệ : * [Một cuốn sách tuyệt vời khác](https://downloads.example.org/book.html)- John Doe (download site) TỆ : * [Một cuốn sách tuyệt vời khác](https://downloads.example.org/book.html)- John Doe (download site)
Tốt: * [Một cuốn sách tuyệt vời khác](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) TỐT: * [Một cuốn sách tuyệt vời khác](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- Bao gồm năm xuất bản trong tiêu đề cho các sách cũ hơn: - Bao gồm năm xuất bản trong tiêu đề cho các sách cũ hơn:
``` ```text
Tệ : * [Một cuốn sách rất tuyệt vời](https://example.org/book.html) - Jane Roe - 1970 TỆ : * [Một cuốn sách rất tuyệt vời](https://example.org/book.html) - Jane Roe - 1970
Tốt: * [Một cuốn sách rất tuyệt vời (1970)](https://example.org/book.html) - Jane Roe TỐT: * [Một cuốn sách rất tuyệt vời (1970)](https://example.org/book.html) - Jane Roe
``` ```
- <a name="in_process"></a>Sách đang trong quá trình viết: - <a name="in_process"></a>Sách đang trong quá trình viết:
``` ```text
Tốt: * [Sách sẽ sớm trở nên tuyệt vời](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*) TỐT: * [Sách sẽ sớm trở nên tuyệt vời](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
``` ```
### Ghi Chú ### Ghi Chú
@ -238,9 +240,9 @@ Nếu bạn có thể in nó ra và giữ lại bản chất của nó, thì đ
- Sử dụng xác thực liên kết [awesome_bot](https://github.com/dkhamsing/awesome_bot) - Sử dụng xác thực liên kết [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- Để kích hoạt xác thực liên kết, hãy push một commit bao gồm một commit message chứa `check_urls=file_to_check`: - Để kích hoạt xác thực liên kết, hãy push một commit bao gồm một commit message chứa `check_urls=file_to_check`:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-vi.md
``` ```
- Bạn có thể chỉ định nhiều tệp để kiểm tra, sử dụng một khoảng trắng duy nhất để tách từng mục nhập. - Bạn có thể chỉ định nhiều tệp để kiểm tra, sử dụng một khoảng trắng duy nhất để tách từng mục nhập.
- Nếu bạn chỉ định nhiều hơn một tệp, kết quả của việc xây dựng sẽ dựa trên kết quả của tệp cuối cùng được kiểm tra. Bạn nên biết rằng bạn có thể nhận được bản xây dựng thành công, vì vậy hãy đảm bảo kiểm tra log ở cuối pull request bằng cách nhấp vào "Show all checks" -> "Details". - Nếu bạn chỉ định nhiều hơn một tệp, kết quả của việc xây dựng sẽ dựa trên kết quả của tệp cuối cùng được kiểm tra. Bạn nên biết rằng bạn có thể nhận được bản xây dựng thành công, vì vậy hãy đảm bảo kiểm tra log ở cuối pull request bằng cách nhấp vào "Show all checks" -> "Details".

View File

@ -73,7 +73,7 @@
举例: 举例:
``` ```text
[...] [...]
* [一本很有用的书](http://example.com/example.html) * [一本很有用的书](http://example.com/example.html)
(空行) (空行)
@ -86,65 +86,65 @@
* 在 `]``(` 之间不要留有空格: * 在 `]``(` 之间不要留有空格:
``` ```text
错误:* [一本很有用的书] (http://example.com/book.html) 错误:* [一本很有用的书] (http://example.com/book.html)
正确:* [一本很有用的书](http://example.com/book.html) 正确:* [一本很有用的书](http://example.com/book.html)
``` ```
* 如果包括作者,请使用' - '(由单个空格(英文半角)包围的破折号) * 如果包括作者,请使用' - '(由单个空格(英文半角)包围的破折号)
``` ```text
错误:* [一本很有用的书](http://example.com/book.html)- 张显宗 错误:* [一本很有用的书](http://example.com/book.html)- 张显宗
正确:* [一本很有用的书](http://example.com/book.html) - 张显宗 正确:* [一本很有用的书](http://example.com/book.html) - 张显宗
``` ```
* 在链接和电子书格式之间放一个空格: * 在链接和电子书格式之间放一个空格:
``` ```text
错误:* [一本很有用的书](https://example.org/book.pdf)(PDF) 错误:* [一本很有用的书](https://example.org/book.pdf)(PDF)
正确:* [一本很有用的书](https://example.org/book.pdf) (PDF) 正确:* [一本很有用的书](https://example.org/book.pdf) (PDF)
``` ```
* 如需备注或注解,请使用英文半角括号`( )` * 如需备注或注解,请使用英文半角括号`( )`
``` ```text
错误:* [一本很有用的书](https://example.org/book.pdf) (繁体中文) 错误:* [一本很有用的书](https://example.org/book.pdf) (繁体中文)
正确:* [一本很有用的书](https://example.org/book.pdf) (繁体中文) 正确:* [一本很有用的书](https://example.org/book.pdf) (繁体中文)
``` ```
* 作者在电子书格式之前: * 作者在电子书格式之前:
``` ```text
错误:* [一本很有用的书](https://example.org/book.pdf)- (PDF) 张显宗 错误:* [一本很有用的书](https://example.org/book.pdf)- (PDF) 张显宗
正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗 (PDF) 正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗 (PDF)
``` ```
* 多重格式: * 多重格式:
``` ```text
错误:* [一本很有用的书](http://example.com/)- 张显宗 (HTML) 错误:* [一本很有用的书](http://example.com/)- 张显宗 (HTML)
错误:* [一本很有用的书](https://downloads.example.org/book.html)- 张显宗 (download site) 错误:* [一本很有用的书](https://downloads.example.org/book.html)- 张显宗 (download site)
正确:* [一本很有用的书](http://example.com/) - 张显宗 (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) 正确:* [一本很有用的书](http://example.com/) - 张显宗 (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
* 多作者,多译者时,请使用中文 `、` 进行分隔,在译者名字后请使用英文半角括号包围的 `(翻译)`,可以用 “等” 缩短作者列表: * 多作者,多译者时,请使用中文 `、` 进行分隔,在译者名字后请使用英文半角括号包围的 `(翻译)`,可以用 “等” 缩短作者列表:
``` ```text
错误:* [一本很有用的书](https://example.org/book.pdf) - 张显宗,岳绮罗 错误:* [一本很有用的书](https://example.org/book.pdf) - 张显宗,岳绮罗
正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗、岳绮罗(翻译) 正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗、岳绮罗(翻译)
正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗、岳绮罗、顾玄武、出尘子 等 正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗、岳绮罗、顾玄武、出尘子 等
``` ```
* 在旧书的标题中包括出版年份: * 在旧书的标题中包括出版年份:
``` ```text
错误:* [一本很有用的书](https://example.org/book.html) - 张显宗 - 1970 错误:* [一本很有用的书](https://example.org/book.html) - 张显宗 - 1970
正确:* [一本很有用的书 (1970)](https://example.org/book.html) - 张显宗 正确:* [一本很有用的书 (1970)](https://example.org/book.html) - 张显宗
``` ```
* <a name="in_process"></a>编写(翻译)中的书籍: * <a name="in_process"></a>编写(翻译)中的书籍:
``` ```text
正确:* [马上出版的一本书](http://example.com/book2.html) - 张显宗 (HTML) (:construction: *编写中*) 正确:* [马上出版的一本书](http://example.com/book2.html) - 张显宗 (HTML) (:construction: *编写中*)
正确:* [马上出版的一本书](http://example.com/book2.html) - 张显宗 (HTML) (:construction: *翻译中*) 正确:* [马上出版的一本书](http://example.com/book2.html) - 张显宗 (HTML) (:construction: *翻译中*)
``` ```

View File

@ -73,7 +73,7 @@
舉例: 舉例:
``` ```text
[...] [...]
* [一本很有用的書](http://example.com/example.html) * [一本很有用的書](http://example.com/example.html)
(空行) (空行)
@ -86,68 +86,68 @@
* 在 `]``(` 之間不要留有空格: * 在 `]``(` 之間不要留有空格:
``` ```text
錯誤:* [一本很有用的書] (http://example.com/book.html) 錯誤:* [一本很有用的書] (http://example.com/book.html)
正確:* [一本很有用的書](http://example.com/book.html) 正確:* [一本很有用的書](http://example.com/book.html)
``` ```
* 如果包括作者,請使用' - '(由單個空格(英文半型)包圍的破折號) * 如果包括作者,請使用' - '(由單個空格(英文半型)包圍的破折號)
``` ```text
錯誤:* [一本很有用的書](http://example.com/book.html)- 張顯宗 錯誤:* [一本很有用的書](http://example.com/book.html)- 張顯宗
正確:* [一本很有用的書](http://example.com/book.html) - 張顯宗 正確:* [一本很有用的書](http://example.com/book.html) - 張顯宗
``` ```
* 在連結和電子書格式之間放一個空格: * 在連結和電子書格式之間放一個空格:
``` ```text
錯誤:* [一本很有用的書](https://example.org/book.pdf)(PDF) 錯誤:* [一本很有用的書](https://example.org/book.pdf)(PDF)
正確:* [一本很有用的書](https://example.org/book.pdf) (PDF) 正確:* [一本很有用的書](https://example.org/book.pdf) (PDF)
``` ```
* 如需備注或注解,請使用英文半型括號`( )` * 如需備注或注解,請使用英文半型括號`( )`
``` ```text
錯誤:* [一本很有用的書](https://example.org/book.pdf) (繁體中文) 錯誤:* [一本很有用的書](https://example.org/book.pdf) (繁體中文)
正確:* [一本很有用的書](https://example.org/book.pdf) (繁體中文) 正確:* [一本很有用的書](https://example.org/book.pdf) (繁體中文)
``` ```
* 作者在電子書格式之前: * 作者在電子書格式之前:
``` ```text
錯誤:* [一本很有用的書](https://example.org/book.pdf)- (PDF) 張顯宗 錯誤:* [一本很有用的書](https://example.org/book.pdf)- (PDF) 張顯宗
正確:* [一本很有用的書](https://example.org/book.pdf) - 張顯宗 (PDF) 正確:* [一本很有用的書](https://example.org/book.pdf) - 張顯宗 (PDF)
``` ```
* 多重格式: * 多重格式:
``` ```text
錯誤:* [一本很有用的書](http://example.com/)- 張顯宗 (HTML) 錯誤:* [一本很有用的書](http://example.com/)- 張顯宗 (HTML)
錯誤:* [一本很有用的書](https://downloads.example.org/book.html)- 張顯宗 (download site) 錯誤:* [一本很有用的書](https://downloads.example.org/book.html)- 張顯宗 (download site)
正確:* [一本很有用的書](http://example.com/) - 張顯宗 (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) 正確:* [一本很有用的書](http://example.com/) - 張顯宗 (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
* 多作者,多譯者時,請使用中文 `、` 進行分隔,在譯者名字後請使用英文半型括號包圍的 `(翻譯)`,可以用 “等” 縮短作者列表: * 多作者,多譯者時,請使用中文 `、` 進行分隔,在譯者名字後請使用英文半型括號包圍的 `(翻譯)`,可以用 “等” 縮短作者列表:
``` ```text
錯誤:* [一本很有用的書](https://example.org/book.pdf) - 張顯宗,岳綺羅 錯誤:* [一本很有用的書](https://example.org/book.pdf) - 張顯宗,岳綺羅
正確:* [一本很有用的書](https://example.org/book.pdf) - 張顯宗、岳綺羅(翻譯) 正確:* [一本很有用的書](https://example.org/book.pdf) - 張顯宗、岳綺羅(翻譯)
正確:* [一本很有用的書](https://example.org/book.pdf) - 張顯宗、岳綺羅、顧玄武、出塵子 等 正確:* [一本很有用的書](https://example.org/book.pdf) - 張顯宗、岳綺羅、顧玄武、出塵子 等
``` ```
* 在舊書的標題中包括出版年份: * 在舊書的標題中包括出版年份:
``` ```text
錯誤:* [一本很有用的書](https://example.org/book.html) - 張顯宗 - 1970 錯誤:* [一本很有用的書](https://example.org/book.html) - 張顯宗 - 1970
正確:* [一本很有用的書 (1970)](https://example.org/book.html) - 張顯宗 正確:* [一本很有用的書 (1970)](https://example.org/book.html) - 張顯宗
``` ```
* <a name="in_process"></a>編寫(翻譯)中的書籍: * <a name="in_process"></a>編寫(翻譯)中的書籍:
``` ```text
正確:* [即將出版的一本書](http://example.com/book2.html) - 張顯宗 (HTML) (:construction: *編寫中*) 正確:* [即將出版的一本書](http://example.com/book2.html) - 張顯宗 (HTML) (:construction: *編寫中*)
正確:* [即將出版的一本書](http://example.com/book2.html) - 張顯宗 (HTML) (:construction: *翻譯中*) 正確:* [即將出版的一本書](http://example.com/book2.html) - 張顯宗 (HTML) (:construction: *翻譯中*)
``` ```
### 自動化測試 ### 自動化測試
@ -156,9 +156,9 @@
- 使用 [awesome_bot](https://github.com/dkhamsing/awesome_bot) 進行連結驗證。 - 使用 [awesome_bot](https://github.com/dkhamsing/awesome_bot) 進行連結驗證。
- 可以藉由提交一個內容包含`check_urls=file_to_check`來觸發連結驗證: - 可以藉由提交一個內容包含`check_urls=file_to_check`來觸發連結驗證:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-zh.md
``` ```
- 您可以以一個空白區隔出想要進行驗證的檔案名稱來一次驗證多個檔案。 - 您可以以一個空白區隔出想要進行驗證的檔案名稱來一次驗證多個檔案。
- 如果您一次驗證多個檔案,自動化測試的結果會是基於最後一個驗證的檔案。您的測試可能會因此通過,因此請詳加確認測試日誌。可以在 pull request 結果中點選"Show all checks" -> "Details" 來查看。 - 如果您一次驗證多個檔案,自動化測試的結果會是基於最後一個驗證的檔案。您的測試可能會因此通過,因此請詳加確認測試日誌。可以在 pull request 結果中點選"Show all checks" -> "Details" 來查看。

View File

@ -74,69 +74,71 @@ The idea is to have:
Example: Example:
[...] ```text
* [An Awesome Book](http://example.com/example.html) [...]
(blank line) * [An Awesome Book](http://example.com/example.html)
(blank line) (blank line)
### Example (blank line)
(blank line) ### Example
* [Another Awesome Book](http://example.com/book.html) (blank line)
* [Some Other Book](http://example.com/other.html) * [Another Awesome Book](http://example.com/book.html)
* [Some Other Book](http://example.com/other.html)
```
- Don't put spaces between `]` and `(`: - Don't put spaces between `]` and `(`:
``` ```text
BAD : * [Another Awesome Book] (http://example.com/book.html) BAD : * [Another Awesome Book] (http://example.com/book.html)
GOOD: * [Another Awesome Book](http://example.com/book.html) GOOD: * [Another Awesome Book](http://example.com/book.html)
``` ```
- If you include the author, use ` - ` (a dash surrounded by single spaces): - If you include the author, use ` - ` (a dash surrounded by single spaces):
``` ```text
BAD : * [Another Awesome Book](http://example.com/book.html)- John Doe BAD : * [Another Awesome Book](http://example.com/book.html)- John Doe
GOOD: * [Another Awesome Book](http://example.com/book.html) - John Doe GOOD: * [Another Awesome Book](http://example.com/book.html) - John Doe
``` ```
- Put a single space between the link and its format: - Put a single space between the link and its format:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.pdf)(PDF) BAD : * [A Very Awesome Book](https://example.org/book.pdf)(PDF)
GOOD: * [A Very Awesome Book](https://example.org/book.pdf) (PDF) GOOD: * [A Very Awesome Book](https://example.org/book.pdf) (PDF)
``` ```
- Author comes before format: - Author comes before format:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.pdf)- (PDF) Jane Roe BAD : * [A Very Awesome Book](https://example.org/book.pdf)- (PDF) Jane Roe
GOOD: * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF) GOOD: * [A Very Awesome Book](https://example.org/book.pdf) - Jane Roe (PDF)
``` ```
- Multiple formats: - Multiple formats:
``` ```text
BAD : * [Another Awesome Book](http://example.com/)- John Doe (HTML) BAD : * [Another Awesome Book](http://example.com/)- John Doe (HTML)
BAD : * [Another Awesome Book](https://downloads.example.org/book.html)- John Doe (download site) BAD : * [Another Awesome Book](https://downloads.example.org/book.html)- John Doe (download site)
GOOD: * [Another Awesome Book](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html) GOOD: * [Another Awesome Book](http://example.com/) - John Doe (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
``` ```
- Include publication year in title for older books: - Include publication year in title for older books:
``` ```text
BAD : * [A Very Awesome Book](https://example.org/book.html) - Jane Roe - 1970 BAD : * [A Very Awesome Book](https://example.org/book.html) - Jane Roe - 1970
GOOD: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe GOOD: * [A Very Awesome Book (1970)](https://example.org/book.html) - Jane Roe
``` ```
- <a name="in_process"></a>In-process books: - <a name="in_process"></a>In-process books:
``` ```text
GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*) GOOD: * [Will Be An Awesome Book Soon](http://example.com/book2.html) - John Doe (HTML) (:construction: *in process*)
``` ```
- <a name="archived"></a>Archived link: - <a name="archived"></a>Archived link:
``` ```text
GOOD: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)* GOOD: * [A Way-backed Interesting Book](https://web.archive.org/web/20211016123456/http://example.com/) - John Doe (HTML) *(:card_file_box: archived)*
``` ```
### Notes ### Notes
@ -235,9 +237,9 @@ If you can print it out and retain its essence, it's not an Interactive Tutorial
- URL validation uses [awesome_bot](https://github.com/dkhamsing/awesome_bot) - URL validation uses [awesome_bot](https://github.com/dkhamsing/awesome_bot)
- To trigger URL validation, push a commit that includes a commit message containing `check_urls=file_to_check`: - To trigger URL validation, push a commit that includes a commit message containing `check_urls=file_to_check`:
``` ```properties
check_urls=free-programming-books.md free-programming-books-en.md check_urls=free-programming-books.md free-programming-books-en.md
``` ```
- You may specify more than one file to check, using a single space to separate each entry. - You may specify more than one file to check, using a single space to separate each entry.
- If you specify more than one file, results of the build are based on the result of the last file checked. You should be aware that you may get passing green builds due to this so be sure to inspect the build log at the end of the pull request by clicking on "Show all checks" -> "Details". - If you specify more than one file, results of the build are based on the result of the last file checked. You should be aware that you may get passing green builds due to this so be sure to inspect the build log at the end of the pull request by clicking on "Show all checks" -> "Details".