diff --git a/docs/index.html b/docs/index.html index cd61cff..fe9311e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -67,26 +67,25 @@ -
-

The goal of scapr is to turn lower-case character format into small capitals. This function wrap the HTML-tag around a character string input as exemplified in Yihui Xie’s chapter on inline-formatting for markdown syntax (cf. Bookdown). I designed this function to help the writing of my thesis in R Markdown that deals with lots of small-capitalisation of words.

+

The goal of scapr is to turn lower-case character format into small capitals. This function wrap the HTML-tag around a character string input as exemplified in Yihui Xie’s chapter on inline-formatting for markdown syntax (cf. Bookdown). I designed this function to help the writing of my thesis in R Markdown that deals with lots of small-capitalisation of words.

Installation

You can install scapr from GitHub with:

-
# install.packages("devtools")
-devtools::install_github("gederajeg/scapr")
+

Example

-
library(scapr)
-

We can use scaps() as an inline R code, e.g. to turn the word happiness into small caps, as follows: `r scaps("happiness")`. It will then produce happiness.

-

There are three other functions in the package for different font-face types of the small-capital string. They are scaps_italics() (for italicised small-captial string), scaps_bold() (for boldfaced small-capital string) and scaps_bolditalics() (for both italicised and boldfaced small-capital string).

+ +

We can use scaps() as an inline R code, e.g. to turn the word happiness into small caps, as follows: `r scaps("happiness")`. It will then produce happiness.

+

There are three other functions in the package for different font-face types of the small-capital string. They are scaps_italics() (for italicised small-captial string), scaps_bold() (for boldfaced small-capital string) and scaps_bolditalics() (for both italicised and boldfaced small-capital string).

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 2aa67b0..108567e 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,4 +1,4 @@ -pandoc: 1.19.2.1 +pandoc: 2.2.2.1 pkgdown: 1.1.0 pkgdown_sha: ~ articles: []