Skip to content

Commit 845e757

Browse files
author
r-leyshon
committed
chore: Adding index link to access_head output
1 parent 2e570f7 commit 845e757

File tree

2 files changed

+47
-40
lines changed

2 files changed

+47
-40
lines changed

docs/accessrmd_guide.Rmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -641,6 +641,8 @@ standard Quick Reference</a> <br> <br>
641641

642642
['access_rmd()' output](docs/test_outputs/access_rmd.html)
643643

644+
['access_head()' output](docs/test_outputs/accessrmd_standard_rmarkdown.html)
645+
644646
***
645647

646648
</body>

index.html

Lines changed: 45 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1648,8 +1648,8 @@ <h4>Setting theme</h4>
16481648
<p>‘access_rmd()’ allows the user to specify which theme should be used to style the text of the rmarkdown document.</p>
16491649
<pre class="r"><code>access_rmd(filenm = &quot;flatly_styling&quot;, title = &quot;Applying the flatly theme&quot;,
16501650
lan = &quot;en&quot;, force = TRUE, theme = &quot;flatly&quot;)</code></pre>
1651-
<pre><code>Warning in access_rmd(filenm = &quot;flatly_styling&quot;, title = &quot;Applying the flatly
1652-
theme&quot;, : &#39;force&#39; is TRUE. Overwriting filenm.</code></pre>
1651+
<pre><code>Warning in access_rmd(filenm = &quot;flatly_styling&quot;, title = &quot;Applying the flatly theme&quot;, :
1652+
&#39;force&#39; is TRUE. Overwriting filenm.</code></pre>
16531653
<pre><code>Warning in insert_yaml(toc = toc, header = header, text = text, lan = lan, : The flatly theme has known accessibility errors and is
16541654
not supported by this function.</code></pre>
16551655
<pre><code>Setting html lan to en</code></pre>
@@ -1658,8 +1658,8 @@ <h4>Setting theme</h4>
16581658
<p>Note that there are accessibility errors with the simplex and cerulean themes. Attempting to apply these themes results in a warning and setting the theme to null.</p>
16591659
<pre class="r"><code>access_rmd(&quot;attempt_simplex&quot;, title = &quot;Attempting to apply simplex theme&quot;,
16601660
lan = &quot;en&quot;, force = TRUE, theme = &quot;simplex&quot;)</code></pre>
1661-
<pre><code>Warning in access_rmd(&quot;attempt_simplex&quot;, title = &quot;Attempting to apply simplex
1662-
theme&quot;, : &#39;force&#39; is TRUE. Overwriting filenm.</code></pre>
1661+
<pre><code>Warning in access_rmd(&quot;attempt_simplex&quot;, title = &quot;Attempting to apply simplex theme&quot;, :
1662+
&#39;force&#39; is TRUE. Overwriting filenm.</code></pre>
16631663
<pre><code>Warning in insert_yaml(toc = toc, header = header, text = text, lan = lan, : The simplex theme has known accessibility errors and is
16641664
not supported by this function.</code></pre>
16651665
<pre><code>Setting html lan to en</code></pre>
@@ -1699,42 +1699,44 @@ <h3><code>retrieve_rmds()</code></h3>
16991699
<p>Searches (recursively) a directory for Rmarkdown files. Returns the found Rmd relative paths.</p>
17001700
<pre class="r"><code>rmds &lt;- retrieve_rmds()
17011701
rmds</code></pre>
1702-
<pre><code> [1] &quot;./accesible_images.rmd&quot;
1703-
[2] &quot;./accessrmd_guide.Rmd&quot;
1704-
[3] &quot;./accessrmd_test.rmd&quot;
1705-
[4] &quot;./attempt_simplex.Rmd&quot;
1706-
[5] &quot;./broken_link.Rmd&quot;
1707-
[6] &quot;./flatly_styling.Rmd&quot;
1708-
[7] &quot;./images.rmd&quot;
1709-
[8] &quot;./more_parameters.Rmd&quot;
1710-
[9] &quot;./some_file.Rmd&quot;
1711-
[10] &quot;./sus_alt_test.Rmd&quot;
1712-
[11] &quot;./test.Rmd&quot;
1713-
[12] &quot;./test_highlights/highlight_breezedark.Rmd&quot;
1714-
[13] &quot;./test_highlights/highlight_default.Rmd&quot;
1715-
[14] &quot;./test_highlights/highlight_espresso.Rmd&quot;
1716-
[15] &quot;./test_highlights/highlight_haddock.Rmd&quot;
1717-
[16] &quot;./test_highlights/highlight_kate.Rmd&quot;
1718-
[17] &quot;./test_highlights/highlight_monochrome.Rmd&quot;
1719-
[18] &quot;./test_highlights/highlight_null.Rmd&quot;
1720-
[19] &quot;./test_highlights/highlight_pygments.Rmd&quot;
1721-
[20] &quot;./test_highlights/highlight_tango.Rmd&quot;
1722-
[21] &quot;./test_highlights/highlight_textmate.Rmd&quot;
1723-
[22] &quot;./test_highlights/highlight_zenburn.Rmd&quot;
1724-
[23] &quot;./test_outputs/access_rmd.Rmd&quot;
1725-
[24] &quot;./test_themes/cerulean.Rmd&quot;
1726-
[25] &quot;./test_themes/cosmo.Rmd&quot;
1727-
[26] &quot;./test_themes/default.Rmd&quot;
1728-
[27] &quot;./test_themes/flatly.Rmd&quot;
1729-
[28] &quot;./test_themes/journal.Rmd&quot;
1730-
[29] &quot;./test_themes/lumen.Rmd&quot;
1731-
[30] &quot;./test_themes/paper.Rmd&quot;
1732-
[31] &quot;./test_themes/readable.Rmd&quot;
1733-
[32] &quot;./test_themes/sandstone.Rmd&quot;
1734-
[33] &quot;./test_themes/simplex.Rmd&quot;
1735-
[34] &quot;./test_themes/spacelab.Rmd&quot;
1736-
[35] &quot;./test_themes/united.Rmd&quot;
1737-
[36] &quot;./test_themes/yeti.Rmd&quot; </code></pre>
1702+
<pre><code> [1] &quot;./accesible_images.rmd&quot;
1703+
[2] &quot;./accessrmd_guide.Rmd&quot;
1704+
[3] &quot;./accessrmd_test.rmd&quot;
1705+
[4] &quot;./attempt_simplex.Rmd&quot;
1706+
[5] &quot;./broken_link.Rmd&quot;
1707+
[6] &quot;./flatly_styling.Rmd&quot;
1708+
[7] &quot;./images.rmd&quot;
1709+
[8] &quot;./more_parameters.Rmd&quot;
1710+
[9] &quot;./some_file.Rmd&quot;
1711+
[10] &quot;./sus_alt_test.Rmd&quot;
1712+
[11] &quot;./test.Rmd&quot;
1713+
[12] &quot;./test_highlights/highlight_breezedark.Rmd&quot;
1714+
[13] &quot;./test_highlights/highlight_default.Rmd&quot;
1715+
[14] &quot;./test_highlights/highlight_espresso.Rmd&quot;
1716+
[15] &quot;./test_highlights/highlight_haddock.Rmd&quot;
1717+
[16] &quot;./test_highlights/highlight_kate.Rmd&quot;
1718+
[17] &quot;./test_highlights/highlight_monochrome.Rmd&quot;
1719+
[18] &quot;./test_highlights/highlight_null.Rmd&quot;
1720+
[19] &quot;./test_highlights/highlight_pygments.Rmd&quot;
1721+
[20] &quot;./test_highlights/highlight_tango.Rmd&quot;
1722+
[21] &quot;./test_highlights/highlight_textmate.Rmd&quot;
1723+
[22] &quot;./test_highlights/highlight_zenburn.Rmd&quot;
1724+
[23] &quot;./test_outputs/access_rmd.Rmd&quot;
1725+
[24] &quot;./test_outputs/accessrmd_standard_rmarkdown.Rmd&quot;
1726+
[25] &quot;./test_outputs/standard_rmarkdown.Rmd&quot;
1727+
[26] &quot;./test_themes/cerulean.Rmd&quot;
1728+
[27] &quot;./test_themes/cosmo.Rmd&quot;
1729+
[28] &quot;./test_themes/default.Rmd&quot;
1730+
[29] &quot;./test_themes/flatly.Rmd&quot;
1731+
[30] &quot;./test_themes/journal.Rmd&quot;
1732+
[31] &quot;./test_themes/lumen.Rmd&quot;
1733+
[32] &quot;./test_themes/paper.Rmd&quot;
1734+
[33] &quot;./test_themes/readable.Rmd&quot;
1735+
[34] &quot;./test_themes/sandstone.Rmd&quot;
1736+
[35] &quot;./test_themes/simplex.Rmd&quot;
1737+
[36] &quot;./test_themes/spacelab.Rmd&quot;
1738+
[37] &quot;./test_themes/united.Rmd&quot;
1739+
[38] &quot;./test_themes/yeti.Rmd&quot; </code></pre>
17381740
<p>This vector of Rmarkdown path names can be used for various operations.</p>
17391741
<pre class="r"><code>for (doc in rmds) {
17401742
print(doc)
@@ -1763,6 +1765,8 @@ <h3><code>retrieve_rmds()</code></h3>
17631765
[1] &quot;./test_highlights/highlight_textmate.Rmd&quot;
17641766
[1] &quot;./test_highlights/highlight_zenburn.Rmd&quot;
17651767
[1] &quot;./test_outputs/access_rmd.Rmd&quot;
1768+
[1] &quot;./test_outputs/accessrmd_standard_rmarkdown.Rmd&quot;
1769+
[1] &quot;./test_outputs/standard_rmarkdown.Rmd&quot;
17661770
[1] &quot;./test_themes/cerulean.Rmd&quot;
17671771
[1] &quot;./test_themes/cosmo.Rmd&quot;
17681772
[1] &quot;./test_themes/default.Rmd&quot;
@@ -2030,6 +2034,7 @@ <h3>Highlights</h3>
20302034
<div id="package-outputs" class="section level3">
20312035
<h3>Package Outputs</h3>
20322036
<p><a href="docs/test_outputs/access_rmd.html">‘access_rmd()’ output</a></p>
2037+
<p><a href="docs/test_outputs/accessrmd_standard_rmarkdown.html">‘access_head()’ output</a></p>
20332038
<hr />
20342039
</body>
20352040
</html>

0 commit comments

Comments
 (0)