Skip to content

Commit 6443f41

Browse files
committed
Add release notes to releases page and prefer Markup.raw.
1 parent 890f3ff commit 6443f41

File tree

7 files changed

+14
-6
lines changed

7 files changed

+14
-6
lines changed

lib/utopia/project/base.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ def format(text, definition = nil, language: definition&.language, **options)
128128
end
129129

130130
if document = self.document(text, definition, language: language)
131-
return XRB::MarkupString.raw(
131+
return XRB::Markup.raw(
132132
document.to_html(**options)
133133
)
134134
end

lib/utopia/project/document.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ def replace_section(name, children: false)
7474

7575
def to_html(node = self.root, **options)
7676
renderer = Renderer.new(ids: true, flags: Markly::UNSAFE, **options)
77-
XRB::MarkupString.raw(renderer.render(node))
77+
XRB::Markup.raw(renderer.render(node))
7878
end
7979

8080
def paragraph_node(child)

pages/_releases.xnode

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,13 @@
88
<section>
99
<h3>#{release.name}</h3>
1010

11+
<?r if notes = release.notes ?>
12+
#{Markup.raw(notes.to_html)}
13+
<?r end ?>
14+
1115
<ul>
1216
<?r release.changes do |change| ?>
13-
<li><a href="#{release.href(anchor: change.id)}">#{MarkupString.raw(change.to_html)}</a></li>
17+
<li><a href="#{release.href(anchor: change.id)}">#{Markup.raw(change.to_html)}</a></li>
1418
<?r end ?>
1519
</ul>
1620
</section>

pages/_usage.xnode

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<h3><a href="#{guide.href}">#{guide.title}</a></h3>
1010

1111
<?r if description = guide.description ?>
12-
#{MarkupString.raw description.to_html}
12+
#{Markup.raw description.to_html}
1313
<?r elsif documentation = guide.documentation ?>
1414
#{base.format(documentation.text, language: guide.documentation.language)}
1515
<?r else ?>

pages/index.xnode

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
?><content:heading>Project</content:heading><?r
2727
end
2828

29-
?>#{MarkupString.raw document.to_html}<?r
29+
?>#{Markup.raw document.to_html}<?r
3030
else
3131
?>
3232
<content:heading>Project</content:heading>

pages/releases/index.xnode

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<content:page>
22
<?r
33
if document = self[:document]
4-
?>#{MarkupString.raw document.to_html}<?r
4+
?>#{Markup.raw document.to_html}<?r
55
else
66
?>
77
<content:heading>Project</content:heading>

releases.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This document outlines major changes and new features in each release of the project.
44

5+
## Unreleased
6+
7+
- Fix presentation of release notes on releases page.
8+
59
## v0.31.0
610

711
- Support brief release notes in `releases.md` document.

0 commit comments

Comments
 (0)