Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Add block quotes #907

Merged
merged 1 commit into from
Jul 29, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 57 additions & 9 deletions doc/rdoc/markup_reference.rb
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
# - {Paragraphs}[rdoc-ref:RDoc::MarkupReference@Paragraphs].
# - {Verbatim text blocks}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks].
# - {Code blocks}[rdoc-ref:RDoc::MarkupReference@Code+Blocks].
# - {Block quotes}[rdoc-ref:RDoc::MarkupReference@Block+Quotes].
# - {Bullet lists}[rdoc-ref:RDoc::MarkupReference@Bullet+Lists].
# - {Numbered lists}[rdoc-ref:RDoc::MarkupReference@Numbered+Lists].
# - {Lettered lists}[rdoc-ref:RDoc::MarkupReference@Lettered+Lists].
Expand Down Expand Up @@ -99,7 +100,10 @@
#
# - Verbatim text blocks.
# - Code blocks.
# - Block quotes.
# - Lists of any type.
# - Headings.
# - Horizontal rules.
#
# ==== Verbatim Text Blocks
#
Expand Down Expand Up @@ -169,6 +173,49 @@
# Pro tip: If your indented Ruby code does not get highlighted,
# it may contain a syntax error.
#
# ==== Block Quotes
#
# You can use the characters <tt>>>></tt> (unindented),
# followed by indented text, to treat the text
# as a {block quote}[https://en.wikipedia.org/wiki/Block_quotation]:
#
# Example input:
#
# >>>
peterzhu2118 marked this conversation as resolved.
Show resolved Hide resolved
# Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
# commodo quam iaculis massa posuere, dictum fringilla justo pulvinar.
# Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.
#
# Aenean congue ligula eu ligula molestie, eu pellentesque purus
# faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum,
# diam in pellentesque aliquet, mi tellus placerat sapien, id euismod
# purus magna ut tortor.
#
# Rendered HTML:
#
# >>>
# Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
# commodo quam iaculis massa posuere, dictum fringilla justo pulvinar.
# Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.
#
# Aenean congue ligula eu ligula molestie, eu pellentesque purus
# faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum,
# diam in pellentesque aliquet, mi tellus placerat sapien, id euismod
# purus magna ut tortor.
#
# A block quote may contain nested blocks, including:
#
# - Other block quotes.
# - Paragraphs.
# - Verbatim text blocks.
# - Code blocks.
# - Lists of any type.
# - Headings.
# - Horizontal rules.
#
# Note that, unlike verbatim text, single newlines are not honored,
# but that a double newline begins a new paragraph in the block quote.
#
# ==== Lists
#
# Each type of list item is marked by a special beginning:
Expand All @@ -190,6 +237,16 @@
# A list item may be continued on additional lines that are aligned
# with the first line. See examples below.
#
# A list item may contain nested blocks, including:
#
# - Other lists of any type.
# - Paragraphs.
# - Verbatim text blocks.
# - Code blocks.
# - Block quotes.
# - Headings.
# - Horizontal rules.
#
# ===== Bullet Lists
#
# A bullet list item begins with a hyphen or asterisk.
Expand Down Expand Up @@ -291,15 +348,6 @@
# [bar baz] Yet another.
# bam:: Last one.
#
# ===== Blocks Nested in Lists
#
# A list item may contain nested blocks, including:
#
# - Paragraphs.
# - Verbatim text blocks.
# - Code blocks.
# - Other lists of any type.
#
# ==== Headings
#
# A heading begins with up to six equal-signs, followed by heading text.
Expand Down