forked from poldham/minute_website
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpublish.html
313 lines (258 loc) · 8.46 KB
/
publish.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
<!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" />
<title>Publish your site on Github</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">Publish your site on Github</h1>
</div>
<div id="add-the-repository-to-github-desktop" class="section level3">
<h3>Add the repository to Github Desktop</h3>
<ol start="4" style="list-style-type: decimal">
<li>If you can’t already see your project folder then add your project folder to github desktop. Write a quick message in Summary then Press commit to queue it up and then Publish/Sync. This will add the site to your github repositories.</li>
</ol>
<div class="figure">
<img src="images/add_github_desktop.png" />
</div>
<ol start="5" style="list-style-type: decimal">
<li>Github will allow you to publish project websites for each of your repositories (known as <code>github pages</code> or <code>gh-pages</code>). They will end up being published at <code>yourusername.github.io/repositoryname</code>.</li>
</ol>
<p>For example, the home for this website is <a href="https://poldham.github.io/minute_website/" class="uri">https://poldham.github.io/minute_website/</a></p>
<div class="figure">
<img src="images/website_address.png" />
</div>
<p>But, this is where we need to take care. In the image above on the left we can see that next to <code>Branch</code> it says <code>master</code>. Websites are published on the github pages branch (<code>gh-pages</code>) branch of a repository to keep them separate (because your repository data and your project website may be quite different things). So, your website is not yet published.</p>
<p>To publish the website we need to go into <code>Settings</code> in our repository and then scroll down. In the image below, where you see <code>master</code> in your repo change the branch to <code>gh-pages</code>. Your simple website will now build at the address given. You are reading this online so it must do. <img src="images/website_gh_pages.png" /></p>
<p>If you have forked and cloned this site then all should be good, because the master branch has been deleted leaving only the <code>gh-pages</code> branch. However, if you have started from scratch you will need the procedure above.</p>
<ol start="6" style="list-style-type: decimal">
<li>Troubleshooting. It can take a few minutes (but not long) for Github to recognise the website. If you see a not found message check three things.</li>
</ol>
<ul>
<li>That you have a line saying <code>output_dir: "."</code> at the bottom of <code>_site.yml</code>.</li>
<li>That you have <code>.nojekyll</code> in your main site folder.</li>
<li>That there is an index.html (you remembered to move it from the <code>_site</code> folder when you updated… easy to forget).</li>
<li>That you have selected the <code>gh-pages</code> branch in <code>Settings</code> in your repo.</li>
<li>If you are using this site as your basis make sure that you have forked and then cloned the repository (the fork makes it your copy, a clone is just a copy).</li>
</ul>
</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>