Skip to content

v1.8.0

Choose a tag to compare

View all tags
@CybotTM CybotTM released this 04 Jan 11:46
· 237 commits to main since this release
v1.8.0
26d24a9
This commit was signed with the committer’s verified signature.
CybotTM Sebastian Mendel
SSH Key Fingerprint: NOxv8dcZlMFz3wrLdHILVNSnF6xskqAjN3bnn0i7K30
Verified
Learn about vigilant mode.

What's Changed

Documentation improvements

  • Prefer literalinclude for complete code examples - Updated guidance to use literalinclude as the preferred method for code blocks of 5+ lines
  • File naming convention - Added underscore prefix convention for code snippet files (_ClassName.php, _config.yaml)
  • File organization - Documented recommended structure for storing code snippets alongside RST files
  • Text markers - Added examples for :start-after: and :end-before: options for maintainable line selection
  • Updated decision guide - Clear guidance on when to use literalinclude vs code-block
  • Pre-commit checklist - Updated to prioritize literalinclude usage

Benefits of literalinclude

  • IDE support for syntax validation
  • Reusability across multiple documentation pages
  • Single source of truth for code examples
  • Testability of code snippets
Assets 4
Loading