/
build_articles.html
169 lines (136 loc) · 6.1 KB
/
build_articles.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Build articles — build_articles • pkgdown</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<!-- mathjax -->
<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">pkgdown</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../articles/pkgdown.html">Intro</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/hadley/pkgdown">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Build articles</h1>
</div>
<p>Each Rmarkdown vignette in <code>vignettes/</code> and its subdirectories is
rendered. Vignettes are rendered using a special document format that
reconciles <code><a href='http://www.rdocumentation.org/packages/html_document/topics/rmarkdown'>html_document</a>()</code> with your pkgdown
template.</p>
<pre><span class='fu'>build_articles</span>(<span class='kw'>pkg</span> <span class='kw'>=</span> <span class='st'>"."</span>, <span class='kw'>path</span> <span class='kw'>=</span> <span class='st'>"docs/articles"</span>, <span class='kw'>depth</span> <span class='kw'>=</span> <span class='fl'>1L</span>)</pre>
<h2 class="hasAnchor" id="arguments">
<a class="anchor" href="#arguments"></a>
Arguments
</h2>
<dl class="dl-horizontal">
<dt>pkg</dt>
<dd>Path to source package.</dd>
<dt>path</dt>
<dd>Output path.</dd>
<dt>depth</dt>
<dd>Depth of path relative to root of documentation.
Used to adjust relative links in the navbar.</dd>
</dl>
<h2 class="hasAnchor" id="yaml-config"><a class="anchor" href="#yaml-config"></a>YAML config</h2>
<p></p>
<p>To tweak the index page, you need a section called <code>articles</code>,
which provides a list of sections containing, a <code>title</code>, list of
<code>contents</code>, and optional <code>description</code>.</p>
<p>For example, this imaginary file describes some of the structure of
the <a href = 'R markdown articles'>http://rmarkdown.rstudio.com/articles.html</a>:</p>
<p><pre>
articles:
- title: R Markdown
contents:
- starts_with("authoring")
- title: Websites
contents:
- rmarkdown_websites
- rmarkdown_site_generators
</pre></p>
<p>Note that <code>contents</code> can contain either a list of vignette names
(including subdirectories), or if the functions in a section share a
common prefix or suffix, you can use <code>starts_with("prefix")</code> and
<code>ends_with("suffix")</code> to select them all. For more complex naming
schemes you can use an aribrary regular expression with
<code>matches("regexp")</code>.</p>
<p>pkgdown will check that all vignettes are included in the index
this page, and will generate a warning if you have missed any.</p>
<h2 class="hasAnchor" id="supressing-vignettes"><a class="anchor" href="#supressing-vignettes"></a>Supressing vignettes</h2>
<p></p>
<p>If you want articles that are not vignettes, either put them in
subdirectories or list in <code>.Rbuildignore</code>. An articles link
will be automatically added to the default navbar if the vignettes
directory is present: if you do not want this, you will need to
customise the navbar. See <code><a href='build_site.html'>build_site</a></code> details.</p>
</div>
<div class="col-md-3 hidden-xs">
<div id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
<li><a href="#yaml-config">YAML config</a></li>
<li><a href="#supressing-vignettes">Supressing vignettes</a></li>
</ul>
</div>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by <a href='http://hadley.nz'>Hadley Wickham</a>, <a href='https://www.rstudio.com'><img src='http://tidyverse.org/rstudio-logo.svg' height='24' /></a>.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
</div>
</footer>
</div>
</body>
</html>