Skip to content

v0.3.20 - Align Markdown tables indented inside MkDocs tabs and admonitions (#896)

Choose a tag to compare

@github-actions github-actions released this 04 Sep 17:58
· 28 commits to main since this release
3e76669

🌟 Summary

v0.3.20 improves Markdown table formatting inside MkDocs tabs and admonitions, while making the CLA workflow safer and more precise.

📊 Key Changes

  • 📝 Improved nested Markdown tables

    • Tables inside MkDocs admonitions such as !!! note and tabs such as === "Tab" are now detected and aligned correctly.
    • Formatting supports CJK characters and common emoji using standard-library Unicode width information.
    • Existing fenced code blocks and ordinary indented code remain unchanged.
    • Reference documentation under docs/**/reference/** remains excluded from table formatting.
    • Added focused tests covering nested tables, tabs, escaped pipe characters, Unicode text, and fenced code.
  • ⚙️ More reliable Markdown processing

    • MkDocs containers and fenced code blocks are tracked during a single forward scan.
    • No new dependencies, installation steps, filesystem traversal, or file-reading behavior were introduced.
    • The formatter was validated against 25 existing table files and all 324 current non-reference documentation files.
  • 🔐 Safer CLA recheck handling

    • The CLA workflow now recognizes recheck only when the entire comment is exactly recheck.
    • CLA signature comments continue to support substring matching.
    • The workflow example in cla/README.md was updated to match.
  • 📦 Version update

    • Bumped the package version from 0.3.19 to 0.3.20.

🎯 Purpose & Impact

  • ✅ Documentation tables in MkDocs tabs and admonitions will be consistently readable and aligned.
  • 🛡️ Code examples are protected from accidental formatting changes, reducing the risk of altering executable snippets.
  • 🌏 Tables containing Chinese, Japanese, Korean, or emoji content should display with more accurate column spacing.
  • 🔁 Markdown formatting remains stable and idempotent, meaning repeatedly running the formatter should not create further changes.
  • 🚦 CLA automation is less likely to trigger unexpectedly from unrelated comments containing the word “recheck.”
  • 🚫 No model architecture, training, inference, or deployment features changed in this release.

What's Changed

New Contributors

Full Changelog: v0.3.19...v0.3.20