summaryrefslogtreecommitdiff
path: root/lib/rdoc/markdown.rb
AgeCommit message (Collapse)Author
2025-01-15Migrate rdoc as bundled gemsHiroshi SHIBATA
Notes: Merged: https://github.com/ruby/ruby/pull/12577
2024-07-18Require space between hash/content in ATX heading (#1140)Hartley McGuire
While writing some Markdown documentation for Rails, I came across an interesting case where trying to link to an instance method at the start of a line would instead parse as an H1 heading: ```markdown #response_body= ``` Expected: ```html <a href=""><code>#response_body=</code></a> ``` Actual: ```html <h1>response_body=</h1> ``` According to the CommonMark spec: > At least one space or tab is required between the # characters and the > heading’s contents, unless the heading is empty. Note that many > implementations currently do not require the space. However, the space > was required by the original ATX implementation, and it helps prevent > things like the following from being parsed as headings: > > Example 64 So while some implementations do not follow this requirement, I believe RDoc should because it makes it easy to write text similar to Example 64 (which was used in the new test) and it also enables automatically linking to instance methods at the start of a line.
2024-05-30Update generated code from ↵Hiroshi SHIBATA
https://github.com/ruby/rdoc/commit/5c7ea6fa15f403b1c84f5b823716f75595c97d8c
2024-03-11[ruby/rdoc] Allow rich definition list labels for MarkdownHartley McGuire
Previously, any sort of "rich" markup for a definition list's label would cause the Markdown parser to not recognize a definition list: ```ruby md = <<~md `one` : This is a definition md doc = RDoc::Markdown.parse(md) doc # => [doc: [para: "<code>one</code>\n: This is a definition"]] ``` This commit tweaks the grammar for Markdown definition lists so that labels can include "rich" markup such as bold (`**`), code (```), etc: ```ruby md = <<~md `one` : This is a definition md doc = RDoc::Markdown.parse(md) doc # => [doc: [list: NOTE [item: ["<code>one</code>"]; [para: "This is a definition"]]]] ``` The [PHP Markdown Extra][1] Spec does not seem to specify whether or not this should be allowed, but it is allowed in the RDoc format: ```ruby rdoc = <<~rdoc +code+:: This is a definition rdoc doc = RDoc::Markup.parse(rdoc) doc # => [doc: [list: NOTE [item: ["+code+"]; [para: "This is a definition"]]]] ``` so accepting this change increases the parity of the two formats. [1]: https://michelf.ca/projects/php-markdown/extra/#def-list https://github.com/ruby/rdoc/commit/8f943bbba4
2023-10-03[DOC] Link fixesBurdetteLamar
2022-12-09Merge RDoc-6.5.0Hiroshi SHIBATA
Notes: Merged: https://github.com/ruby/ruby/pull/6890
2022-10-06[ruby/rdoc] Remove trailing spaces to fix CITakashi Kokubun
https://github.com/ruby/ruby/actions/runs/3199301563/jobs/5224898228 https://github.com/ruby/rdoc/commit/369e4fa32d60bc00982801a6848efe5338603ac5
2022-10-06[ruby/rdoc] Add center alignNobuyoshi Nakada
https://github.com/ruby/rdoc/commit/512cc55a0e
2022-10-06[ruby/rdoc] Allow spaces around pipesNobuyoshi Nakada
https://github.com/ruby/rdoc/commit/3b3a583580
2022-10-06[ruby/rdoc] Allow escaped pipes in cellsNobuyoshi Nakada
https://github.com/ruby/rdoc/commit/333952a62d
2022-10-06[ruby/rdoc] Allow leading pipes to be ommittedNobuyoshi Nakada
https://github.com/ruby/rdoc/commit/d263a2c9c4
2022-10-06[ruby/rdoc] Allow trailing pipes to be ommittedNobuyoshi Nakada
https://github.com/ruby/rdoc/commit/1318048877
2022-08-08[ruby/rdoc] Allow multiple footnotes without in-between blank linesNobuyoshi Nakada
https://github.com/ruby/ruby/commit/e4e054e3ce40 used four footnotes without blank lines. And the ChangeLog generated from that commit resulted in ``undefined method `parts' for nil`` error. For now, let a footnote terminated by the next footnote mark. Also refined the error message when undefined footnote is used. https://github.com/ruby/rdoc/commit/a7f290130b
2022-02-12[ruby/rdoc] Relative loading for easier development ↵Ulysse Buonomo
(https://github.com/ruby/rdoc/pull/821) This patch makes sure we only load relative code. Hence when coding or testing rdoc, we'll be sure to always be using the correct code. Discussion started at https://github.com/ruby/rdoc/pull/817. Signed-off-by: Ulysse Buonomo <[email protected]> https://github.com/ruby/rdoc/commit/aa41bd48eb Co-authored-by: Nobuyoshi Nakada <[email protected]>
2022-02-12[ruby/rdoc] Optimize RawLine by using a regexp instead of negative ↵Yusuke Endoh
look-ahead rule This improves the performance in some cases. `rdoc .../gems/sinatra-2.1.0/README.md` takes 10.5 sec. before this change, and 7.1 sec. after this change. `make rdoc` of ruby/ruby takes 19.3 sec. before this change, 18.1 sec. after this change. https://github.com/ruby/rdoc/commit/7cf8281e3e
2021-08-10Update parser files of RDoc generated by the latest KPegaycabta
2021-03-16[ruby/rdoc] Get rid of a trailing spaceNobuyoshi Nakada
https://github.com/ruby/rdoc/commit/7b7b91768e Notes: Merged: https://github.com/ruby/ruby/pull/4274
2021-03-16[ruby/rdoc] Suppress unused variable warning of "text"aycabta
https://github.com/ruby/rdoc/commit/3a4120b155 Notes: Merged: https://github.com/ruby/ruby/pull/4274
2021-03-16[ruby/rdoc] Fixed CodeFence without blank linesNobuyoshi Nakada
Currently a fenced code block needs a preceding blank line, it should not be required, as: https://github.github.com/gfm/#fenced-code-blocks > A fenced code block may interrupt a paragraph, and does not > require a blank line either before or after. Just recommended: https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks > We recommend placing a blank line before and after code blocks > to make the raw formatting easier to read. https://github.com/ruby/rdoc/commit/0e1776caf3 Notes: Merged: https://github.com/ruby/ruby/pull/4274
2021-03-16[ruby/rdoc] Support GFM tableNobuyoshi Nakada
https://github.com/ruby/rdoc/commit/9dc933df16 Notes: Merged: https://github.com/ruby/ruby/pull/4274
2020-11-12Backport cosmetic changes from upstream repo that is ruby/rdocHiroshi SHIBATA
2018-03-26Merge RDoc 6.0.3 from upstream.hsbt
It fixed the several bugs that was found after RDoc 6 releasing. From: SHIBATA Hiroshi <[email protected]> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@62924 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-11-27Merge rdoc-6.0.0.beta4 from upstream.hsbt
It version applied `frozen_string_literal: true` git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60920 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-10-10* remove trailing spaces.svn
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60147 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-10-10Merge rdoc-6.0.0.beta3.hsbt
* It version introduced did you mean? feature for ri command: https://github.com/ruby/rdoc/pull/533 * Removed obbsoleted ruby_token.rbb. [Bug #13990][ruby-core:83180] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60146 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-09-12* remove trailing spaces.svn
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59846 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-09-12Merge rdoc-6.0.0.beta2 from upstream.hsbt
* This version changed lexer used Ripper from lexer based IRB. see details: https://github.com/ruby/rdoc/pull/512 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59845 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-08-29* remove trailing spaces.svn
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59687 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-08-29Merge rdoc-6.0.0.beta1.hsbt
This version fixed strange behavior of ruby code parser. We will list all of impromovement to Changelog when 6.0.0 releasing. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59686 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-11-05* remove trailing spaces.svn
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56587 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-11-05* lib/rdoc/*, test/rdoc/*: Update rdoc-5.0.0hsbt
Release note: https://github.com/rdoc/rdoc/blob/b825775647f62c5b525e9780a28ff2fbb1d5bf6f/History.rdoc#500--2016-11-05 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56586 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-09-07* lib/rdoc/*, test/rdoc/*: Update rdoc-5.0.0.beta1hsbt
This version is mostly same as r56072. It contains to remove code for Ruby 1.8 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56079 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-09-05* remove trailing spaces.svn
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56073 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2016-09-05* lib/rdoc/*, test/rdoc/*: Update rdoc/rdoc master(f191513)hsbt
https://github.com/rdoc/rdoc/blob/master/History.rdoc#423--2016-- https://github.com/rdoc/rdoc/blob/master/History.rdoc#422--2016-02-09 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56072 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-12-16Add frozen_string_literal: false for all filesnaruse
When you change this to true, you may need to add more tests. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53141 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-12-07* remove trailing spaces.svn
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@48733 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-12-07* lib/rdoc: Update to RDoc 4.2.0.drbrain
* test/rdoc: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@48732 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-09-19* remove trailing spaces, append newline at EOF.nobu
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42976 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-09-19* lib/rdoc/markdown/literals_1_9.rb: Fix trailing whitespace.drbrain
Previously kpeg (which generates this file) added trailing whitespace, but this bug is now fixed. * lib/rdoc/markdown.rb: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42972 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-09-18* lib/rdoc: Update to RDoc 4.1.0.preview.1drbrain
RDoc 4.1.0 contains a number of enhancements including a new default style and accessibility support. You can see the changelog here: https://github.com/rdoc/rdoc/blob/v4.1.0.preview.1/History.rdoc * test/rdoc: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42971 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-12-01markdown.rb: \rnobu
* lib/rdoc/markdown.rb (RDoc::Markdown): use \r instead of raw control code. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38102 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-11-30* lib/rdoc/markdown.rb: Fixed warnings with -wdrbrain
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38017 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-11-29remove trailing spaces.nobu
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37965 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-11-27* lib/rdoc*: Updated to RDoc 4.0 (pre-release)drbrain
* bin/rdoc: ditto * test/rdoc: ditto * NEWS: Updated with RDoc 4.0 information git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37889 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-18 18:20:51 +0000