Skip to content

Commit 929a3aa

Browse files
authored
Fix typos, grammar and link to CommonMark (#19)
1 parent 2a7da0a commit 929a3aa

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.Rmd

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ knitr::opts_chunk$set(
2424

2525
marquee is a markdown parser and renderer for the R graphics engine. It can be
2626
used to render rich text formatted as markdown (CommonMark) inside R graphics
27-
such as ggplot2 or other graphics build on grid
27+
such as ggplot2 or other graphics built on grid.
2828

2929
## Installation
3030

@@ -37,6 +37,7 @@ pak::pak("r-lib/marquee")
3737
```
3838

3939
## Examples
40+
4041
The main function of the package is `marquee_grob()` which creates a grob based
4142
on markdown text and a style that can be rendered with grid:
4243

@@ -60,13 +61,15 @@ grob <- marquee_grob(readme, style = fancy_style)
6061
grid.draw(grob)
6162
```
6263

63-
(*The above is an image - go ahead and check*)
64+
(*The above is an image go ahead and check*)
6465

6566
## Prior art
67+
6668
I would be remiss to not mention [gridtext](https://github.com/wilkelab/gridtext)
6769
and [ggtext](https://github.com/wilkelab/ggtext), both by Claus Wilke. These
68-
packages aims to solve much the same as marquee, but work in a different way and
69-
doesn't have the same powerful textshaping backend as marquee. Most notably from
70+
packages aim to solve much the same problem as marquee, but work in a different way
71+
and don't have the same powerful textshaping backend as marquee. Most notably from
7072
a user perspective is perhaps that gridtext understands HTML to some degree,
71-
whereas marquee is oblivious to both HTML and CSS. Instead it supports the full
72-
CommonMark spec with the plan to add support for custom span elements as well.
73+
whereas marquee is oblivious to both HTML and CSS. Instead, it supports the [full
74+
CommonMark spec](https://spec.commonmark.org/) with the plan to add support for
75+
custom span elements as well.

0 commit comments

Comments
 (0)