-
Notifications
You must be signed in to change notification settings - Fork 34
/
structure.html
358 lines (305 loc) · 9.71 KB
/
structure.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="pandoc" />
<meta name="author" content="Paul Oldham" />
<title>Understanding Site Structure</title>
<script src="site_libs/jquery-1.11.3/jquery.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<link href="site_libs/highlightjs-1.1/default.css" rel="stylesheet" />
<script src="site_libs/highlightjs-1.1/highlight.js"></script>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
pre:not([class]) {
background-color: white;
}
</style>
<script type="text/javascript">
if (window.hljs && document.readyState && document.readyState === "complete") {
window.setTimeout(function() {
hljs.initHighlighting();
}, 0);
}
</script>
<style type="text/css">
h1 {
font-size: 34px;
}
h1.title {
font-size: 38px;
}
h2 {
font-size: 30px;
}
h3 {
font-size: 24px;
}
h4 {
font-size: 18px;
}
h5 {
font-size: 16px;
}
h6 {
font-size: 12px;
}
.table th:not([align]) {
text-align: left;
}
</style>
</head>
<body>
<style type = "text/css">
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
code {
color: inherit;
background-color: rgba(0, 0, 0, 0.04);
}
img {
max-width:100%;
height: auto;
}
.tabbed-pane {
padding-top: 12px;
}
button.code-folding-btn:focus {
outline: none;
}
</style>
<style type="text/css">
/* padding for bootstrap navbar */
body {
padding-top: 51px;
padding-bottom: 40px;
}
/* offset scroll position for anchor links (for fixed navbar) */
.section h1 {
padding-top: 56px;
margin-top: -56px;
}
.section h2 {
padding-top: 56px;
margin-top: -56px;
}
.section h3 {
padding-top: 56px;
margin-top: -56px;
}
.section h4 {
padding-top: 56px;
margin-top: -56px;
}
.section h5 {
padding-top: 56px;
margin-top: -56px;
}
.section h6 {
padding-top: 56px;
margin-top: -56px;
}
</style>
<script>
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark it active
menuAnchor.parent().addClass('active');
// if it's got a parent navbar menu mark it active as well
menuAnchor.closest('li.dropdown').addClass('active');
});
</script>
<div class="container-fluid main-container">
<!-- tabsets -->
<script>
$(document).ready(function () {
window.buildTabsets("TOC");
});
</script>
<!-- code folding -->
<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"></a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">Home</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Next Steps
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="writepage.html">Writing Pages</a>
</li>
<li>
<a href="images.html">Include Images</a>
</li>
<li>
<a href="embed.html">Embed a webpage</a>
</li>
<li>
<a href="info.html">Embed an infographic</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Change the Structure
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="structure.html">Site structure</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Publish to Github
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="publish.html">publish</a>
</li>
<li>
<a href="yourfile.html">submenu item</a>
</li>
</ul>
</li>
<li>
<a href="resources.html">Resources</a>
</li>
<li>
<a href="paul.html">My Evil Plot</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div class="fluid-row" id="header">
<h1 class="title toc-ignore">Understanding Site Structure</h1>
<h4 class="author"><em>Paul Oldham</em></h4>
<h4 class="date"><em>30/08/2017</em></h4>
</div>
<p>In RStudio web pages are built from the Rmarkdown (.Rmd) files. So,</p>
<ul>
<li>index.Rmd becomes index.html</li>
<li>writepage.Rmd becomes writepage.html</li>
</ul>
<p>When we use the Build button, the rmarkdown files are converted to html. Those html files become the pages of the website in the site structure.</p>
<p>The structure of the site is contained in the file <code>_site.yml</code>. It looks like this.</p>
<pre class="r"><code>name: "Create a simple Rmarkdown website"
output:
html_document:
theme: cosmo
#highlight: textmate
navbar:
left:
- text: "Home"
href: index.html
- text: "Next Steps"
menu:
- text: "Writing Pages"
href: writepage.html
- text: "Include Images"
href: images.html
- text: "Embed a webpage"
href: embed.html
- text: "Embed an infographic"
href: info.html
- text: "Change the Structure"
menu:
- text: "Site structure"
href: structure.html
- text: "Publish to Github"
menu:
- text: "publish"
href: publish.html
- text: "submenu item"
href: yourfile.html
output_dir: "."</code></pre>
<div id="the-basics" class="section level3">
<h3>The basics</h3>
<p>The site structure starts with the name of the site. Then we have the output as html_document and a theme. For available themes see the <a href="http://rmarkdown.rstudio.com/html_document_format.html">RStudio</a> websites section. You can also choose the text highlight option (commented out with # here).</p>
<p>Next comes location of the navigation bar.</p>
</div>
<div id="the-index-file" class="section level3">
<h3>The index file</h3>
<p>All websites must have an index file. In this case the <code>- text:</code> provides the instruction on what to call the menu item <code>"Home"</code>. Below that we have the reference to the html file that corresponds with home. To build a website on GitHub you must have an index file, so this goes here.</p>
<p>An important point here is that the indents matter. If they are slightly out the site will create an error or not display properly. Use the tab key to make sure things are properly aligned.</p>
<pre class="r"><code>- text: "Home"
href: index.html</code></pre>
</div>
<div id="menus-and-sub-menus" class="section level3">
<h3>Menus and sub menus</h3>
<p>To create sub-menus on the navigation bar we start by giving the text that we want to see in the menu. Next we specify that this is a menu and then indent the pages that appear under the menu with text and href.</p>
<pre class="r"><code>- text: "Next Steps"
menu:
- text: "Writing Pages"
href: mypage.html
- text: "Include Images"
href: images.html
- text: "Embed a webpage"
href: embed.html
- text: "Embed an infographic"
href: info.html</code></pre>
<p>If we want a new sub-menu we simply repeat the above with the relevant titles and links to the html files.</p>
<p>The most important things to remember here are:</p>
<ul>
<li>The indents above really matter. If the site will not build it is probably because the indents of - text and href are not aligned.</li>
<li>The file names matter. If the markdown file is called info1 it will rended as info1.html. If you put info.html into the structure then the <code>_site.yml</code> will not find info1.html and that will cause a problem.</li>
</ul>
</div>
<div id="output_dir" class="section level2">
<h2>output_dir</h2>
<p>This is set to “.” if you want to publish the site on GitHub. For other options see the <a href="http://rmarkdown.rstudio.com/rmarkdown_websites.html#publishing_websites">Publishing Websites</a> section of the RStudio guide.</p>
</div>
</div>
<script>
// add bootstrap table styles to pandoc tables
function bootstrapStylePandocTables() {
$('tr.header').parent('thead').parent('table').addClass('table table-condensed');
}
$(document).ready(function () {
bootstrapStylePandocTables();
});
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>