You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A \emph{GitBook} is a useful tool for creating (open?) educational resources. It is an online ``book'' format, that can be hosted directly from a GitHub repository. You are currently reading a GitBook designed to help you get started creating your own educational GitBooks for your courses (how meta!). It does this in two ways: By explaining how to create GitBooks, and by serving as a template that you can copy and edit, instead of having to start from scratch. This template GitBook has all the settings that I consider to be useful for educational GitBooks, but you can always customize it.
138
138
139
-
I will focus specifically on GitBooks that are made in \href{www.rstudio.com}{Rstudio}, using the \href{https://rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf}{\texttt{rmarkdown} markup language}, rendered using the \href{https://bookdown.org/yihui/bookdown/get-started.html}{\texttt{bookdown} package}, and hosted on \href{www.github.com}{GitHub}. If you want to get started, skip ahead to Chapter \ref{prerequisites}; if you need more convincing, keep reading below.
139
+
I will focus specifically on GitBooks that are made in \href{www.rstudio.com}{Rstudio}, using the \href{https://rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf}{\texttt{rmarkdown} markup language}, rendered using the \href{https://bookdown.org/yihui/bookdown/get-started.html}{\texttt{bookdown} package}, and hosted on \href{https://github.com/}{GitHub}. If you want to get started, skip ahead to Chapter \ref{prerequisites}; if you need more convincing, keep reading below.
140
140
141
141
\hypertarget{why-use-a-gitbook-for-teaching}{%
142
142
\section{Why use a GitBook for teaching?}\label{why-use-a-gitbook-for-teaching}}
Go to \href{https://github.com/}{github.com} and click ``Sign up''. Choose an ``Individual'', ``Free'' plan.
198
+
Go to \url{https://github.com/} and click ``Sign up''. Choose an ``Individual'', ``Free'' plan.
199
199
\item
200
200
Request a \href{https://help.github.com/en/articles/applying-for-an-educator-or-researcher-discount}{free academic upgrade}. This allows you to create \emph{private repositories}, which are only visible to you and selected collaborators, and can be made public when your work is published.
<h1class="title">A GitBook Example for Teaching</h1>
174
174
<pclass="author"><em><ahref="https://www.uu.nl/staff/CJvanLissa">dr. Caspar J. van Lissa</a></em></p>
175
-
<pclass="date"><em>2020-03-28</em></p>
175
+
<pclass="date"><em>2020-03-29</em></p>
176
176
</div>
177
177
<divid="about-gitbooks" class="section level1">
178
178
<h1><spanclass="header-section-number">Chapter 1</span> About GitBooks</h1>
179
179
<p><imgsrc="img/using_gitbook.jpeg" /></p>
180
180
<p>A <em>GitBook</em> is a useful tool for creating (open?) educational resources. It is an online “book” format, that can be hosted directly from a GitHub repository. You are currently reading a GitBook designed to help you get started creating your own educational GitBooks for your courses (how meta!). It does this in two ways: By explaining how to create GitBooks, and by serving as a template that you can copy and edit, instead of having to start from scratch. This template GitBook has all the settings that I consider to be useful for educational GitBooks, but you can always customize it.</p>
181
-
<p>I will focus specifically on GitBooks that are made in <ahref="www.rstudio.com">Rstudio</a>, using the <ahref="https://rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf"><code>rmarkdown</code> markup language</a>, rendered using the <ahref="https://bookdown.org/yihui/bookdown/get-started.html"><code>bookdown</code> package</a>, and hosted on <ahref="www.github.com">GitHub</a>. If you want to get started, skip ahead to Chapter <ahref="prerequisites.html#prerequisites">2</a>; if you need more convincing, keep reading below.</p>
181
+
<p>I will focus specifically on GitBooks that are made in <ahref="www.rstudio.com">Rstudio</a>, using the <ahref="https://rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf"><code>rmarkdown</code> markup language</a>, rendered using the <ahref="https://bookdown.org/yihui/bookdown/get-started.html"><code>bookdown</code> package</a>, and hosted on <ahref="https://github.com/">GitHub</a>. If you want to get started, skip ahead to Chapter <ahref="prerequisites.html#prerequisites">2</a>; if you need more convincing, keep reading below.</p>
<li>Go to <ahref="https://github.com/">github.com</a> and click “Sign up”. Choose an “Individual”, “Free” plan.</li>
194
+
<li>Go to <ahref="https://github.com/"class="uri">https://github.com/</a> and click “Sign up”. Choose an “Individual”, “Free” plan.</li>
195
195
<li>Request a <ahref="https://help.github.com/en/articles/applying-for-an-educator-or-researcher-discount">free academic upgrade</a>. This allows you to create <em>private repositories</em>, which are only visible to you and selected collaborators, and can be made public when your work is published.</li>
196
196
</ul></li>
197
197
<li>Connect Rstudio to Git and Github (for more support, see <ahref="https://support.rstudio.com/hc/en-us/articles/200532077-Version-Control-with-Git-and-SVN">this Rstudio article</a>, and <ahref="https://www.r-bloggers.com/rstudio-and-github/">this blog post</a>)
<li>Click <em>Create RSA Key</em>. Do not enter a passphrase. Press <em>Create</em>. A window with some information will open, which you can close.</li>
203
203
<li>Click <em>View public key</em>, and copy the entire text to the clipboard.</li>
204
204
<li>Close Rstudio (it might offer to restart by itself; this is fine)</li>
205
-
<li>Go to <ahref="https://www.github.com">www.github.com</a></li>
205
+
<li>Go to <ahref="https://github.com"class="uri">https://github.com</a></li>
206
206
<li>Click your user icon, click <em>Settings</em>, and then select the <em>SSH and GPG keys</em> tab.</li>
207
207
<li>Click <em>New SSH key</em>. Give it an arbitrary name (e.g., your computer ID), and paste the public key from your clipboard into the box labeled “<em>Key</em>”.</li>
208
208
<li>Open Rstudio again (unless it restarted by itself)</li>
0 commit comments