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] Mods to section Text Markup #916

Merged
merged 1 commit into from
Aug 11, 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
26 changes: 16 additions & 10 deletions doc/rdoc/markup_reference.rb
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
# - {Directive}[rdoc-ref:RDoc::MarkupReference@Directives]:
# various special directions for the rendering.
# - {Text Markup}[rdoc-ref:RDoc:MarkupReference@Text+Markup]:
# text to be rendered in italic, bold, or monofont.
# text to be rendered in a special way.
#
# About the blocks:
#
Expand Down Expand Up @@ -632,18 +632,24 @@
#
# ==== Text Markup
#
# Text markup is metatext that marks text as:
# Text markup is metatext that affects HTML rendering:
#
# - Italic.
# - Bold.
# - Monofont.
# - Typeface: italic, bold, monofont.
# - Character conversions: copyright, trademark, certain punctuation.
# - Links.
# - Escapes: marking text as "not markup."
#
# Text markup may contain only one type of nested block:
# ===== Typeface Markup
#
# - More text markup:
# Typeface markup can specify that text is to be rendered
# as italic, bold, or monofont.
#
# Typeface markup may contain only one type of nested block:
#
# - More typeface markup:
# italic, bold, monofont.
#
# ===== Italic
# ====== Italic
#
# Text may be marked as italic via HTML tag <tt><i></tt> or <tt><em></tt>.
#
Expand Down Expand Up @@ -698,7 +704,7 @@
#
# ====== _Italic_ in a Heading
#
# ===== Bold
# ====== Bold
#
# Text may be marked as bold via HTML tag <tt><b></tt>.
#
Expand Down Expand Up @@ -755,7 +761,7 @@
#
# ===== *Bold* in a Heading
#
# ===== Monofont
# ====== Monofont
#
# Text may be marked as monofont
# -- sometimes called 'typewriter font' --
Expand Down