Skip to content

Releases: ruby/rdoc

v8.0.0

26 Jun 11:40
4e303b3

Choose a tag to compare

What's Changed

💥 Breaking Changes

  • Change default ruby parser to RDoc::Parser::PrismRuby by @tompng in #1581
  • Remove deprecated CLI options and directives by @st0012 in #1616
  • Refactor formatter options by @st0012 in #1623
  • Remove unused memoized caches from Context by @st0012 in #1644
  • Add server mode with live reload (rdoc --server) by @st0012 in #1620
  • Drop Ripper-based parser by @st0012 in #1690

✨ Enhancements

🐛 Bug Fixes

  • Stop generating a separate page file for main_page by @st0012 in #1624
  • Fix markdown table parser consuming lines without pipes as table rows by @st0012 in #1626
  • Fix section comments with the prism parser by @Earlopain in #1639
  • Fix deadlock on Ctrl+C in server mode by @st0012 in #1649
  • Fix server mode live reload for C files by @st0012 in #1647
  • Don't auto-link to non-text source files in cross-references by @st0012 in #1646
  • Fix encoding error when C parser reads external source files by @st0012 in #1657
  • Fix page links returning 404 in server mode by @st0012 in #1671
  • Fix indentation not being preserved on first line in code fences by @extern-c in #1672
  • Fix broken sidebar links for chained class aliases by @st0012 in #1675
  • Preserve # prefix for unresolved cross-references by @st0012 in #1676
  • Fix Markdown blockquote parsing by @st0012 in #1627
  • Stop lazy alias resolver from overwriting real classes (#1662) by @st0012 in #1689
  • Strip markdown HTML comments within paragraph by @tompng in #1698
  • Remove obsolete -V short flag from --visibility option by @st0012 in #1703
  • Change "check syntax" message when it isn't a ruby file by @rwstauner in #1715
  • Avoid detecting encoding comments in documentation text by @st0012 in #1727
  • Fix colorization of imaginary/rational numbers by @Earlopain in #1733
  • Simplify CrossReference resolve by @tompng in #1571

📚 Documentation

  • [DOC] Move RubygemsHook doc to the right place by @st0012 in #1629
  • Add comparison with GitHub Flavored Markdown spec by @st0012 in #1550
  • Add user-facing configuration reference by @st0012 in #1692
  • Add RDoc logo to documentation by @st0012 in #1734

🛠 Other Changes

Read more

v7.0.4

12 May 04:27

Choose a tag to compare

What's Changed

🐛 Bug Fixes

  • Fix encoding error when C parser reads external source files by @st0012 in #1657

Full Changelog: v7.0.3...v7.0.4

v7.2.0

09 Feb 21:18
d6422f4

Choose a tag to compare

What's Changed

✨ Enhancements

  • Expand GitHub style references in ChangeLog to URL by @nobu in #1547
  • Highlight bash commands by @st0012 in #1544

🐛 Bug Fixes

  • Replace attribute_manager with a new rdoc-inline-format parser by @tompng in #1559
  • Fix not scrolling in search results when ArrowUp or ArrowDown for Aliki by @ccmywish in #1587
  • Implement escapes in Markdown to RDoc conversion by @tompng in #1575
  • Change PrismRuby not to depend on hack that stores module nesting information to context.parent by @tompng in #1580
  • Hide search results on Escape key on desktop too for Aliki by @ccmywish in #1593
  • Fix visit_call_node visit arguments twice by @tompng in #1596
  • Fix accept_table with incomplete rows by @st0012 in #1599
  • Fix sections not displaying their text by @Earlopain in #1600
  • Ignore visibility method, attr definition, module_function within block by @tompng in #1595
  • Fix broken legacy rdoc-ref labels and duplicate heading IDs by @st0012 in #1602
  • Add unique IDs to section headings in Aliki template by @st0012 in #1603
  • Fix RDoc::Attr#add_alias handling of aliased attribute accessor by @extern-c in #1605

📚 Documentation

  • Fix broken RDoc Markup Reference link in RDoc::Comment by @extern-c in #1566
  • Add missing quote for 'unknown' by @p8 in #1589

🛠 Other Changes

New Contributors

Full Changelog: v7.1.0...v7.2.0

v7.1.0

13 Jan 16:56
8fe3e30

Choose a tag to compare

What's Changed

✨ Enhancements

  • Support GitHub style markdown heading anchor and link reference by @st0012 in #1540
  • Allow using backticks to quote text in RDoc markup too by @st0012 in #1551

🐛 Bug Fixes

  • Fix comment_location for merged ClassModule by @tompng in #1531
  • Prevent style rendering in code blocks by @st0012 in #1536
  • Improve code block language detection by @st0012 in #1538
  • Fix Markdown strikethrough (~~text~~) not rendering in HTML output by @st0012 in #1541
  • Define Markup::Heading as a struct on rubies older than v4.0.0 by @vinistock in #1549
  • Fix cross-reference resolution for constants by @extern-c in #1539

📚 Documentation

  • Rebuild RDoc markup documentation by @st0012 in #1542
  • [DOC] Remove italic bold styling inside codeblock by @tompng in #1552
  • Use playwright MCP as the recommended way to test RDoc end to end by @st0012 in #1545
  • Fix broken RDoc Markup Reference links in RDoc::Markup by @extern-c in #1560

🛠 Other Changes

Full Changelog: v7.0.3...v7.1.0

v7.0.3

24 Dec 18:51
d676630

Choose a tag to compare

What's Changed

🐛 Bug Fixes

  • Fix comment location marshalling in ClassModule by @st0012 in #1529

📚 Documentation

🛠 Other Changes

Full Changelog: v7.0.2...v7.0.3

v7.0.2

22 Dec 10:57
fe2fe63

Choose a tag to compare

What's Changed

🐛 Bug Fixes

  • Fix class/module alias document having wrong name by @tompng in #1515
  • Change sidebar hiding strategy to avoid flickering on mobile devices by @st0012 in #1516
  • Fix search dropdown behaviour by @st0012 in #1512

🛠 Other Changes

Full Changelog: v7.0.1...v7.0.2

v7.0.1

18 Dec 15:07
85ac545

Choose a tag to compare

What's Changed

🐛 Bug Fixes

  • [Aliki] Fix search result type styling on mobile by @Earlopain in #1509
  • Make sure path link in footers work correctly by @st0012 in #1508

🛠 Other Changes

Full Changelog: v7.0.0...v7.0.1

v7.0.0

18 Dec 12:26
e4e79c4

Choose a tag to compare

What's Changed

✨ Enhancements

🐛 Bug Fixes

  • Fix method source code not created if a method's description is skipped by @extern-c in #1488
  • Fix call-seq deduplicate for name overlap in aliases by @tompng in #1491

📚 Documentation

  • Replace CONTRIBUTING.rdoc with CONTRIBUTING.md by @st0012 in #1496

🛠 Other Changes

New Contributors

Full Changelog: v6.17.0...v7.0.0

v6.17.0

07 Dec 16:02
108d617

Choose a tag to compare

What's Changed

✨ Enhancements

🐛 Bug Fixes

  • Aliki: Make hamburger toggle non-selectable by @Earlopain in #1480
  • Remove align-self from nav that restricted toc-list width by @tompng in #1486
  • Fix source code styling issues by @st0012 in #1487

🛠 Other Changes

New Contributors

Full Changelog: v6.16.1...v6.17.0

v6.16.1

28 Nov 10:00
6079cda

Choose a tag to compare

What's Changed

✨ Enhancements

  • Add version query string to Aliki assets for cache busting by @st0012 in #1476

Full Changelog: v6.16.0...v6.16.1