free-programming-books/docs/CONTRIBUTING-zh.md

160 lines
8.9 KiB
Markdown
Raw Normal View History

feat: Add `docs/readme.md` + update crosslinks (#6700) * complete translate list with the new languages appeared since hacktoberfest * Create docs/README.md with the translations section using root README.md as source. Links are adapted to this folder Address EbookFoundation/free-programming-books#6698 * fix remaining url + translation items - Portuguese (Portugal) - Slovak / slovenčina - Slovenian / slovenščina Address EbookFoundation/free-programming-books#6698 * fix remaining url + translation items - Portuguese (Portugal) - Slovak / slovenčina - Slovenian / slovenščina Address EbookFoundation/free-programming-books#6698 * Add inclusiveness `dare to translate...` paragraph * Add inclusiveness `dare to translate...` paragraph * Move translations link target url to docs * move translation links `bs` * move translations link `en` * move translations crosslink `es` * move translations crosslink `fr` * move translations crosslink `de` * move translations crosslink `el` * move translations crosslink `fa_IR` * move translations crosslink `fil` * move translations crosslink `it` * move translations crosslink `pt_BR` * move translations crosslink `ko` * move translations crosslink `ru` * move translations crosslink `id` * move translations crosslink `zh` * move translations crosslink `hi` * move translations crosslink `pl` * move translations crosslink `uk` * move translations crosslink `vi` * move translations crosslink remaining `HOW-To's` * revert feature moved to #6688 * Remove the list from the top level. Leave `en` links * use `previous languages` in root README * Add more languages lists in root `readme.md` * fix typo * fix typo * Update docs/README.md after translations paragraph Less text is more Co-authored-by: Eric Hellman <eric@hellman.net> * Update README.md after translations paragraph Less text is more Co-authored-by: Eric Hellman <eric@hellman.net> * Update README.md preface translations paragraph Co-authored-by: Eric Hellman <eric@hellman.net> * fix CONTRIBUTING target url commited at fd2b39151c7d61c4b4b0bd99a96ed231614b9a15 * Update docs/README.md preface translations paragraph Co-authored-by: Eric Hellman <eric@hellman.net> * read me! said the boss ^^, less text is more. Co-authored-by: Eric Hellman <eric@hellman.net> * remove "The inclusiveness is one of our targets, so " Co-authored-by: Eric Hellman <eric@hellman.net>
2022-02-11 17:27:07 +00:00
*[阅读本文的其他语言版本](README.md#nslations)*
## 贡献者许可协议
move the translated documentation files to a docs folder (#6614) * new branch for misc cleanup * add item to resolve #6319 * fix grammar * re-collate * centralize all the translation links * one more * fix link * localize labels * move files * fix links * indent in arabic Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * typos Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * remove Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translation Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translation Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * mixed markdown Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * period Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * missing * Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * Update docs/HOWTO-pl.md Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * Update docs/HOWTO-th.md Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translated Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translate Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lower case Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * typo Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * wording Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translations link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * space Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * space Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * typo Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * Update CONTRIBUTING-de.md * space Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * parens not brackets * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * add #6619 * chore: resolve dead code CONTRIB-es Addressed at https://github.com/EbookFoundation/free-programming-books/pull/6614#commitcomment-60517997 Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277 * chore: use spanish translated text for "translations" Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277 * chore: DRY. Use markdown link refs as translations target Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277 * fix: revert removed parens in previous commit 6276a21d85c963b159b9ca9a02a7f863b1bccc39 Review suggestion: https://github.com/EbookFoundation/free-programming-books/pull/6614#discussion_r751697277 * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lint Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lint Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lint Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * lint Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * fix link Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * space Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> * translate Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com> Co-authored-by: David Ordás <3125580+davorpa@users.noreply.github.com>
2021-11-20 18:25:15 +00:00
请遵循此[许可协议](../LICENSE)参与贡献。
## 贡献者行为准则
feat: Add `docs/readme.md` + update crosslinks (#6700) * complete translate list with the new languages appeared since hacktoberfest * Create docs/README.md with the translations section using root README.md as source. Links are adapted to this folder Address EbookFoundation/free-programming-books#6698 * fix remaining url + translation items - Portuguese (Portugal) - Slovak / slovenčina - Slovenian / slovenščina Address EbookFoundation/free-programming-books#6698 * fix remaining url + translation items - Portuguese (Portugal) - Slovak / slovenčina - Slovenian / slovenščina Address EbookFoundation/free-programming-books#6698 * Add inclusiveness `dare to translate...` paragraph * Add inclusiveness `dare to translate...` paragraph * Move translations link target url to docs * move translation links `bs` * move translations link `en` * move translations crosslink `es` * move translations crosslink `fr` * move translations crosslink `de` * move translations crosslink `el` * move translations crosslink `fa_IR` * move translations crosslink `fil` * move translations crosslink `it` * move translations crosslink `pt_BR` * move translations crosslink `ko` * move translations crosslink `ru` * move translations crosslink `id` * move translations crosslink `zh` * move translations crosslink `hi` * move translations crosslink `pl` * move translations crosslink `uk` * move translations crosslink `vi` * move translations crosslink remaining `HOW-To's` * revert feature moved to #6688 * Remove the list from the top level. Leave `en` links * use `previous languages` in root README * Add more languages lists in root `readme.md` * fix typo * fix typo * Update docs/README.md after translations paragraph Less text is more Co-authored-by: Eric Hellman <eric@hellman.net> * Update README.md after translations paragraph Less text is more Co-authored-by: Eric Hellman <eric@hellman.net> * Update README.md preface translations paragraph Co-authored-by: Eric Hellman <eric@hellman.net> * fix CONTRIBUTING target url commited at fd2b39151c7d61c4b4b0bd99a96ed231614b9a15 * Update docs/README.md preface translations paragraph Co-authored-by: Eric Hellman <eric@hellman.net> * read me! said the boss ^^, less text is more. Co-authored-by: Eric Hellman <eric@hellman.net> * remove "The inclusiveness is one of our targets, so " Co-authored-by: Eric Hellman <eric@hellman.net>
2022-02-11 17:27:07 +00:00
请同意并遵循此[行为准则](CODE_OF_CONDUCT.md)参与贡献。([translations](README.md#nslations))
## 概要
2020-10-10 23:25:40 +00:00
1. "一个可以轻易下载一本书的链接" 并不代表它指向的就是 *免费* 书籍。 请只提供免费内容。 确信你所提供的书籍是免费的。我们不接受指向*需要*工作电子邮件地址才能获取书籍的页面的链接,但我们欢迎有需求它们的列表。
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
2020-10-10 23:25:40 +00:00
2. 你不需要会 Git如果你发现了一些有趣的东西 *尚未出现在本仓库* 中,请开一个[Issue](https://github.com/EbookFoundation/free-programming-books/issues)进行主题讨论。
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
* 如果你已经知晓Git请Fork本仓库并提交Pull Request (PR)。
chore(docs): Apply #6822 (playground definition) to the rest of CONTRIBUTING files (#6824) * Added playground definition Added a small definition about programming/coding playgrounds for making it understandable to beginners * Define what is a playground Via / completes: - What's a programming playground? #6107 - Added playground definition #6817 - Sentence added under playground #6819 Thanks @Suman373 for the initial idea. Co-authored-by: Suman Roy <95040233+Suman373@users.noreply.github.com> * reword playground definition as suggested Co-authored-by: Eric Hellman <eric@hellman.net> * copy #6822 playground definition into rest files * translate #6822 (playground definition) to spanish * translate #6822 (playground definition) to italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * translate #6822 (playground definition) to french Thanks to @Existential-nonce Co-authored-by: nonce <77142078+Existential-nonce@users.noreply.github.com> * translate EbookFoundation#6822 (playground definition) to chinese Provided by @kang8. Thank you too much! Co-authored-by: kang <1115610574@qq.com> * Improve playground definition in `zh_TW` language Co-authored-by: Alan Syue <33183531+AlanSyue@users.noreply.github.com> * Minor improve playground definition in `fr` language Co-authored-by: lorrding <mathias.berthonneau@gmail.com> Co-authored-by: Suman Roy <95040233+Suman373@users.noreply.github.com> Co-authored-by: Eric Hellman <eric@hellman.net> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: nonce <77142078+Existential-nonce@users.noreply.github.com> Co-authored-by: kang <1115610574@qq.com> Co-authored-by: Alan Syue <33183531+AlanSyue@users.noreply.github.com> Co-authored-by: lorrding <mathias.berthonneau@gmail.com>
2022-07-25 12:37:35 +00:00
3. 这里有6种列表请选择正确的一个
* *Books* PDF、HTML、ePub、基于一个 gitbook.io的站点、一个Git仓库等等。
* *Courses* :课程是一种学习材料,而不是一本书 [This is a course](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-006-introduction-to-algorithms-fall-2011/)。
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
* *Interactive Tutorials* :一个交互式网站,它允许用户输入代码或命令并对结果进行评估。例如:[Try Haskell](http://tryhaskell.org)[Try GitHub](http://try.github.io)。
chore(docs): Apply #6822 (playground definition) to the rest of CONTRIBUTING files (#6824) * Added playground definition Added a small definition about programming/coding playgrounds for making it understandable to beginners * Define what is a playground Via / completes: - What's a programming playground? #6107 - Added playground definition #6817 - Sentence added under playground #6819 Thanks @Suman373 for the initial idea. Co-authored-by: Suman Roy <95040233+Suman373@users.noreply.github.com> * reword playground definition as suggested Co-authored-by: Eric Hellman <eric@hellman.net> * copy #6822 playground definition into rest files * translate #6822 (playground definition) to spanish * translate #6822 (playground definition) to italian Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> * translate #6822 (playground definition) to french Thanks to @Existential-nonce Co-authored-by: nonce <77142078+Existential-nonce@users.noreply.github.com> * translate EbookFoundation#6822 (playground definition) to chinese Provided by @kang8. Thank you too much! Co-authored-by: kang <1115610574@qq.com> * Improve playground definition in `zh_TW` language Co-authored-by: Alan Syue <33183531+AlanSyue@users.noreply.github.com> * Minor improve playground definition in `fr` language Co-authored-by: lorrding <mathias.berthonneau@gmail.com> Co-authored-by: Suman Roy <95040233+Suman373@users.noreply.github.com> Co-authored-by: Eric Hellman <eric@hellman.net> Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com> Co-authored-by: nonce <77142078+Existential-nonce@users.noreply.github.com> Co-authored-by: kang <1115610574@qq.com> Co-authored-by: Alan Syue <33183531+AlanSyue@users.noreply.github.com> Co-authored-by: lorrding <mathias.berthonneau@gmail.com>
2022-07-25 12:37:35 +00:00
* *Playgrounds* : Playgrounds 可能是学习编程的在线交互式网站、游戏或桌面软件。你可以在上面编写、编译、运行或分享代码片段。Playgrounds 通常允许你 fork 代码然后在其中尽情的编写代码。
* *Podcasts and Screencasts* :播客和视频。
* *Problem Sets & Competitive Programming* :一个网站或软件,让你通过解决简单或复杂的问题来评估你的编程技能,有或没有代码审查,有或没有与其他用户对比结果。
4. 确保遵循下面的[基本准则](#基本准则),并遵循本仓库文件的[Markdown规定格式](#规定格式)。
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
5. GitHub Actions 将运行测试,以确保你的列表是 **按字母顺序排列** 的,并 **遵循格式化规则**。请 **确保** 你的更改通过了该测试。
### 基本准则
2020-10-10 23:25:40 +00:00
* 确保你提交的每一本书都是免费的。如有需要请做Double-check。如果你在PR中注明为什么你认为这本书是免费的这将对管理员是很有帮助的。
2021-10-23 02:24:49 +00:00
* 我们不接受存储在Google Drive、Dropbox、Mega、Scribd、Issuu和其他类似文件上传平台上的文件。
* 请按照字母顺序插入链接, as described [below](#alphabetical-order).
* 使用最权威来源的链接(意思是原作者的网站比编辑的网站好,比第三方网站好)。
* 没有文件托管服务(包括(但不限于)Dropbox和谷歌驱动器链接)。
* 优先选择使用 `https` 链接,而不是 `http` 链接 -- 只要它们位于相同的域并提供相同的内容。
* 在根域上,去掉末尾的斜杠:使用 `http://example.com` 代替 `http://example.com/`
* 总是选择最短的链接:使用 `http://example.com/dir/` 比使用 `http://example.com/dir/index.html` 更好。
2020-10-10 23:25:40 +00:00
* 不要提供短链接
* 优先选择使用 "current" 链接代替有 "version" 链接:使用 `http://example.com/dir/book/current/` 比使用 `http://example.com/dir/book/v1.0.0/index.html` 更好。
* 如果一个链接存在过期的证书/自签名证书/SSL问题的任何其他类型
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
1. *replace it* :如果可能的话,将其 *替换* 为对应的`http`(因为在移动设备上接受异常可能比较复杂)。
2. *leave it* :如果没有`http`版本,但仍然可以通过`https`访问链接,则在浏览器中添加异常或忽略警告。
3. *remove it* :上述以外删除掉它。
* 如果一个链接以多种格式存在,请添加一个单独的链接,并注明每种格式。
* 如果一个资源存在于Internet上的不同位置
* 使用最权威来源的链接(意思是原始作者的网站比编辑的网站好,比第三方网站好)。
* 如果它们链接到不同的版本,你认为这些版本差异很大,值得保留,那么添加一个单独的链接,并对每个版本做一个说明(参见[Issue #2353](https://github.com/EbookFoundation/free-programming-books/issues/2353)有助于格式化问题的讨论)。
* 相较一个比较大的提交,我们更倾向于原子提交(通过添加/删除/修改进行一次提交)。在提交PR之前没有必要压缩你的提交。(我们永远不会执行这个规则,因为这只是维护人员的方便)。
* 如果一本书比较旧,请在书名中注明出版日期。
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
* 包含作者的名字或适当的名字。中文版本可以用 “`等`” (“`et al.`”) 缩短作者列表。
* 如果一本书还没有完成,并且仍在编写中,则需添加 “`in process`” 符号,参见[下文](#in_process)所述。
* 如果在开始下载之前需要电子邮件地址或帐户设置,请在括号中添加合适的语言描述,例如:`(*需要*电子邮件,但不是必须的)`。
### 规定格式
* 所有列表都是`.md`文件。试着学习[Markdown](https://guides.github.com/features/mastering-markdown/)语法。它很容易上手!
* 所有的列表都以索引开始。它的作用是列出并链接所有的sections(章节/段落)或subsections(子段落/子章节)。务必遵循字母顺序排列。
* Sections(章节/段落)使用3级标题(`###`)subsections(子段落/子章节)使用4级标题 (`####`)。
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
整体思想为:
* `2` 新添加的Section与末尾链接间必须留有`2`个空行
* `1` :标题和第一个链接之间必须留有`1`个空行的空行
* `0` :任何两个链接之间不能留有任何空行
* `1` :每个`.md`文件末尾必须留有`1`个空行
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
举例:
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
[...]
* [一本很有用的书](http://example.com/example.html)
(空行)
(空行)
### 电子书种类标题
(空行)
* [Another 很有用的书](http://example.com/book.html)
* [Other 有用的书](http://example.com/other.html)
```
*`]``(` 之间不要留有空格:
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
错误:* [一本很有用的书] (http://example.com/book.html)
正确:* [一本很有用的书](http://example.com/book.html)
```
* 如果包括作者,请使用' - '(由单个空格(英文半角)包围的破折号)
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
错误:* [一本很有用的书](http://example.com/book.html)- 张显宗
正确:* [一本很有用的书](http://example.com/book.html) - 张显宗
```
* 在链接和电子书格式之间放一个空格:
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
错误:* [一本很有用的书](https://example.org/book.pdf)(PDF)
正确:* [一本很有用的书](https://example.org/book.pdf) (PDF)
```
* 如需备注或注解,请使用英文半角括号`( )`
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
错误:* [一本很有用的书](https://example.org/book.pdf) (繁体中文)
正确:* [一本很有用的书](https://example.org/book.pdf) (繁体中文)
```
* 作者在电子书格式之前:
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
错误:* [一本很有用的书](https://example.org/book.pdf)- (PDF) 张显宗
正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗 (PDF)
```
* 多重格式:
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
错误:* [一本很有用的书](http://example.com/)- 张显宗 (HTML)
错误:* [一本很有用的书](https://downloads.example.org/book.html)- 张显宗 (download site)
正确:* [一本很有用的书](http://example.com/) - 张显宗 (HTML) [(PDF, EPUB)](https://downloads.example.org/book.html)
```
* 多作者,多译者时,请使用中文 `、` 进行分隔,在译者名字后请使用英文半角括号包围的 `(翻译)`,可以用 “等” 缩短作者列表:
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
错误:* [一本很有用的书](https://example.org/book.pdf) - 张显宗,岳绮罗
正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗、岳绮罗(翻译)
正确:* [一本很有用的书](https://example.org/book.pdf) - 张显宗、岳绮罗、顾玄武、出尘子 等
```
* 在旧书的标题中包括出版年份:
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
错误:* [一本很有用的书](https://example.org/book.html) - 张显宗 - 1970
正确:* [一本很有用的书 (1970)](https://example.org/book.html) - 张显宗
```
* <a id="in_process"></a>编写(翻译)中的书籍:
docs(contributing): Homogenize format across translated files (#6625) * docs(contributing): remove trailing spaces * docs(contributing): Apply headings `2-1` empty lines lint rule * docs(contributing): Apply headings `2-1` empty lines lint rule forgotten in previous commit: e83220aa4c66680c69f7134690e8482d749bb3c5 * docs(contributing): Move anchor alias to inside list items ... there where an anchor alias `<a name="...">` is used near to each of those list items This solves markdownlint `MD032/blanks-around-lists` issue * docs(contributing): Homogenize `1` blank line in nutshell enumeration * docs(contributing): Homogenize `1` blank line inside Formatting section * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param * 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] * docs(contributing): Ensure `4-spaces` indent `.editorconfig` param Forgotten in commit: 31c776cb529b8e4b573cef83ed26abc75d4a293a * docs(contributing): Homogenize format & indent of code blocks - Simulate `Good` - `Bad` monospace double colon indent inside each one. Revert commit f9dc719aef899896bebc92d5423ed53badf80f92 only in this file after check non-needs in a deployed web snapshot * docs(contributing): Use "consistent" unordered list mark Solves markdownlint rules: MD004/ul-style: Unordered list style "consistent" * docs(contributing): Solve `no-space-in-*` lint rules markdownlint rules: MD037/no-space-in-emphasis: Spaces inside emphasis MD038/no-space-in-code: Spaces inside code span elements MD039/no-space-in-links: Spaces inside link text * docs(contributing): Move some punctuation just before any closing brackets after it * docs(contributing): Hack highlight IDE/Editors headings+HTML It apply the hack to highlight in IDE/Editors those headings with an anchor alias just before itself * docs(contributing): Homogenize Pull Request acronym * docs(contributing): Fix `GitHub` trademark typos * docs(contributing): ALLCAPS * docs(contributing): Git trademark * docs(contributing): YouTube trademark * docs(contributing): ISBN acronym * fix: flag emoji code `en` > `us` Resolves https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#commitcomment-59537594 #5831: `:en:` emoji flag markup doesn't work. Use `:us:` :us: or `:gb:` :gb: https://github.com/EbookFoundation/free-programming-books/commit/d775cb34fbf5eadbdaa465bf46510cc4974151f8#diff-b35eb40c148657d4ea1361c44496e11c5625f484a4c6040c022770e88cbcfdccR8-R10 * docs(contributing): Fix fa_IR broken anchors * docs(contributing): filenames in monospace font * docs(contributing): Homogenize `check_urls=file_to_check` * docs(contributing): literals/markup texts in monospace font - `et al.` - File extensions `.md` - Protocols: `http`, `https`... - Notes: LeanPub, require email, StackOverflow, in process, archived trailing dots in that lines * docs(contributing): linkify wayback machine * docs(contributing): Fix `Leanpub` trademark typos * chore: Rename `master` to `main` #blacklivesmatter Resolves EbookFoundation/free-programming-books#5803 * docs(contributing): fix broken ref link to `programming-playgrounds` Fix over EbookFoundation/free-programming-books#5449 and commit 3c42c3629ed302fd5818454472c49f11a27ca477 (cherry picked from commit 59ebfe3f97e318fa43d58877cbc5bfdd8b0c7426) * docs(contributing): fix repo urls on initial FR translation - `ElivreFoundation` -> `EbookFoundation` - `free-programming-livres` ->`free-programming-books` PR: #5554 Commit: e629db6b05a72fd64a6b33feeeebbe830641cf10 Affected lines: - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13 - https://github.com/EbookFoundation/free-programming-books/pull/5554/commits/18bb745c90e7bdfec40e04b27140f6783588184b#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 // https://github.com/EbookFoundation/free-programming-books/commit/e629db6b05a72fd64a6b33feeeebbe830641cf10#diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45 * docs(contributing): use relative urls EN Via #6614 * docs(contributing): greek. place translations link in right place Via #6614 * Merge EbookFoundation/free-programming-books#6631 upstream/main commit into docs/contributing/sync/1 * Add repo badges (see EbookFoundation/free-programming-books#5983) (cherry picked from a16a79b12deec3527a6b51c0271df21b8b29f9a6 solving merge conflict) * Merge EbookFoundation/free-programming-books#6662 upstream/main commit into docs/contributing/sync/1 * Apply centering proposed at #5983 but not implemented in #6631 (cherry picked from commit f36fd03c0673f15ab57dc151ae70a3346436b95f) * format(contributing): Bold 5th nutshell equal zh * Merge #6677 upstream/main commit into docs/contributing/sync/1 fix(docs): Use Kramdown processor (#6677) * Update _config.yml * add markdown="1" * update url * complete removing spaces? * explicitly use kramdown (cherry picked from commit de2f31976f726803f4bfb2ee1cf9519c58fcd2b2)
2022-02-03 01:39:27 +00:00
```text
正确:* [马上出版的一本书](http://example.com/book2.html) - 张显宗 (HTML) (:construction: *编写中*)
正确:* [马上出版的一本书](http://example.com/book2.html) - 张显宗 (HTML) (:construction: *翻译中*)
```
### Alphabetical order
- When there are multiple titles beginning with the same letter order them by the second, and so on. For example: `aa` comes before `ab`.
- `one two` comes before `onetwo`
If you see a misplaced link, check the linter error message to know which lines should be swapped.