* Add RTL/LTR Markdown linter for mixed-direction text consistency and PR annotation
Introduce a Python-based linter (scripts/rtl_ltr_linter.py) to automatically detect and annotate issues related to mixed Right-To-Left (RTL) and Left-To-Right (LTR) text in Markdown files. The linter analyzes list items, book entries, and metadata for potential bidirectional text rendering problems, such as missing Unicode directionality markers (RLM/LRM) and improper handling of LTR keywords or symbols in RTL contexts.
Key features:
- Scans all Markdown files in the repository, with full logs saved as workflow artifacts.
- Annotates only changed or added lines in pull requests, providing targeted feedback in the GitHub Actions Job Summary.
- Detects common RTL/LTR issues, including:
- Missing directionality markers after LTR keywords (e.g., "HTML") or symbols (e.g., "C#") in RTL text.
- BIDI (bidirectional) mismatches that may affect text display.
- Incorrect ordering of author names and metadata in RTL contexts.
- Configurable via rtl_linter_config.yml for keywords, symbols, and severity levels.
- Includes a GitHub Actions workflow (rtl-ltr-linter.yml) for automated checks on PRs.
* Add test cases for RTL/LTR linter in English and Arabic book lists
Add sample entries to free-programming-books-en.md and free-programming-books-ar.md to test the RTL/LTR Markdown linter.
These test cases include various combinations of RTL and LTR text, keywords, symbols, and metadata to verify that the linter correctly detects directionality issues and outputs the expected logs and annotations.
* Restore original book lists after RTL/LTR linter test cases
Revert test entries in free-programming-books-en.md and free-programming-books-ar.md, restoring the original book lists. This commit removes temporary test data used for validating the RTL/LTR Markdown linter, preparing the repository for merging the PR with a clean state.
No functional changes to the linter or configuration files; only test content has been removed.
* Update RTL/LTR linter workflow and script: run only on RTL file changes or "RTL" label, fail only on errors
The GitHub Actions workflow for the RTL/LTR Markdown linter now runs only if:
- The PR modifies .md files related to RTL languages (ar, he, fa, ur), or
- The PR has the "RTL" label.
The linter script has been updated to fail the check only if errors are found on changed lines, not for warnings.
* Only upload linter artifact if linter step runs
Prevent warning about missing artifact by uploading the linter output log only if the linter step was executed (success or failure). This avoids unnecessary warnings when the linter is skipped because no RTL files were changed and no RTL label is present.
* Test workflow: modify non-RTL markdown file
Modified free-programming-books-en.md to verify that the RTL/LTR linter workflow does not run when only non-RTL markdown files are changed and the "RTL" label is not present.
* Test workflow: modify RTL markdown file to trigger linter
Modified free-programming-books-ar.md to verify that the RTL/LTR linter workflow runs as expected when an RTL markdown file is changed.
* Fix RTL/LTR BIDI issues in some markdown files
Applied directional markers (‎, ‏) and other formatting fixes to resolve BIDI (bidirectional text) errors and warnings reported by the linter in several .md files.
* Fix workflow: upload linter log only if linter step has not been skipped
Updated the workflow to upload the linter output artifact only when the linter step was actually executed (not skipped)
* Add debug step to check linter outcome in workflow
Added a debug step after the linter execution in the workflow to print the outcome and conclusion of the run_linter step.
* Set continue-on-error for linter step to allow artifact upload and debug
* Remove workflow debug step and update markdown file
Removed the debug step from the RTL/LTR linter workflow and applied further changes to a markdown file.
* Fix RTL/LTR BIDI issues in some markdown files
Applied directional markers (‎, ‏) and other formatting fixes to resolve BIDI (bidirectional text) errors and warnings reported by the linter in several .md files. This commit is a second batch of corrections to improve RTL/LTR rendering and pass the linter checks.
* Fix RTL/LTR BIDI issues in some markdown files
Applied directional markers (‎, ‏) and other formatting fixes to resolve BIDI (bidirectional text) errors and warnings reported by the linter in several .md files. This commit is a third batch of corrections to improve RTL/LTR rendering and pass the linter checks.
* Do not produce log file if no issues found
Updated the linter script to avoid creating the log file when no issues, warnings, or notices are found. If no issues are detected, the script now prints a "::notice ::No issues found"
* Always print annotation with number of errors and warnings found
Updated the linter script to always print an annotation indicating how many errors and warnings were found, even if there are none.
* Fix: always print summary annotation with number of issues found
* Add a missing newline character at end of file free-courses-he.md
* Update linter configuration and revert markdown files to pre-fix state
Updated the organization of keywords and symbols in the linter configuration file. Reverted all markdown files to their original state prior to the fixes.
* Update free-programming-books-he.md with fixes
* Update free-programming-books-he.md with further fixes
* Update free-programming-books-he.md with fixes
* Update free-programming-books-fa_IR.md with fixes
* Update free-programming-books-he.md with further fixes
* Update free-programming-books-ar.md with fixes
* Update free-programming-books-ar.md with further fixes
* Update free-podcasts-screencasts-ar.md with fixes
* Update free-podcasts-screencasts-fa_IR.md with fixes
* Update free-courses-he.md with fixes
* Update free-courses-he.md with further fixes
* Update free-courses-fa_IR.md with fixes
* Update free-courses-fa_IR.md with further fixes
* Update free-courses-ar.md with fixes
* Update free-courses-ar.md with further fixes
* Update free-courses-ar.md with further fixes
* Update free-courses-ur.md with fixes
* Update some markdown files with further improvements
* Fix alignment of nested lists in free-programming-books-fa_IR.md
* Update CONTRIBUTING.md and CONTRIBUTING-it.md with RTL/LTR linter error fixing guidelines
Added a section to CONTRIBUTING.md and CONTRIBUTING-it.md explaining how to fix RTL/LTR Markdown linter errors, including when to use ‏ and ‎ with practical examples for contributors working on files with mixed RTL and LTR text
* format: update syntax of `in process` anotation (CONTRIBUTING-*)
from (🚧 *in process*)
to *(🚧 in process)*
* format: apply notes syntax to `in_process` resources
- Applied note `*(🚧 in process)*` translating `in process` to underlying language there where we have previous translated text
- Used regex to detect most of notes: `((\*[^\*]+\*)|(_[^_]+_))`
* apply to new resources added in #7082
* Update books/free-programming-books-subjects.md
Co-authored-by: Leithen <lcrider@cvent.com>
---------
Co-authored-by: Eric Hellman <eric@hellman.net>
Co-authored-by: Leithen <lcrider@cvent.com>
* complete creators guidelines with relator terms
* Update CONTRIBUTING.md
minor language editing
* Update CONTRIBUTING.md
recover missing MARC relators URL to complete empty link
* chore: copy ENG missing texts to translated files
* chore: translate new texts to spanish
* chore: translate new text to italian
Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
Co-authored-by: Eric Hellman <eric@hellman.net>
Co-authored-by: ImVector <59611597+LuigiImVector@users.noreply.github.com>
* 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>
Co-authored-by: Suman Roy <95040233+Suman373@users.noreply.github.com>
Co-authored-by: Eric Hellman <eric@hellman.net>
* 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: e83220aa4c
* 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: 31c776cb52
* docs(contributing): Homogenize format & indent of code blocks
- Simulate `Good` - `Bad` monospace double colon indent inside each one.
Revert commit f9dc719aef 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 d775cb34fb (commitcomment-59537594)#5831: `:en:` emoji flag markup doesn't work. Use `🇺🇸` 🇺🇸 or `🇬🇧` 🇬🇧d775cb34fb (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 3c42c3629e
(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: e629db6b05
Affected lines:
- 18bb745c90 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4) // e629db6b05 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R4)
- 18bb745c90 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7) // e629db6b05 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R7)
- 18bb745c90 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13) // e629db6b05 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R13)
- 18bb745c90 (diff-d6fa57ebb070f7f05f8c686a2fe92110652f48886774460ffee08d4be4cd5f27R45) // e629db6b05 (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 a16a79b12d 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 f36fd03c06)
* 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 de2f31976f)
