Skip to content

v1.1.1

Latest

Choose a tag to compare

@ddotta ddotta released this 15 Jan 08:56
· 3 commits to main since this release

quartify 1.1.1

New Features

  • Roxygen2 Documentation Rendering:
    • Roxygen2 documentation blocks (#') are now automatically formatted into structured callouts resembling pkgdown reference pages
    • Rendered documentation includes: title, source line reference, description, usage with function signature, arguments, return value, details, and examples
    • LaTeX-style formatting is automatically converted to Markdown:
      • \href{url}{text} becomes [text](url)
      • \code{text} becomes `text`
      • \strong{text} becomes **text**
      • \emph{text} becomes *text*
    • Multi-line parameter descriptions and details are properly formatted
    • Custom sections (via @section) are supported and displayed

Bug Fixes

  • CRAN Compliance:
    • Added Words: qmd to DESCRIPTION to prevent spell-check warning
    • Added pattern ^CRAN_CHECKLIST_.*\.md$ to .Rbuildignore to exclude CRAN checklist files
  • Metadata Processing: Fixed issue where empty lines and comments between metadata fields were not properly ignored, creating unwanted empty code chunks
  • Section Header Detection: Improved regex pattern for hidden comments to correctly exclude RStudio section headers (##, ###, ####) from being filtered out

Documentation

  • Removed duplicate sections (Mermaid diagrams, Callouts) from advanced-features vignettes - these topics are now only in getting-started vignettes with correct syntax
  • Added comprehensive documentation for roxygen2 rendering feature

Full Changelog: v1.1.0...v1.1.1