-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
116 lines (92 loc) · 5.15 KB
/
index.html
File metadata and controls
116 lines (92 loc) · 5.15 KB
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
<!DOCTYPE html>
<html>
<head>
<title>Author Carpentry</title>
<link rel="stylesheet" href="css/site.css">
</head>
<body>
<header>
<a href="http://authorcarpentry.github.io"><img src="img/AClogo.jpg" alt="Author Carpentry logo"></a>
</header>
<nav>
<ul>
<li><a href=".">Lesson</a></li>
<li><a href="00-getting-started.html">Topic 1: Getting Started</a></li>
<li><a href="01-markdown-syntax.html">Topic 2: Syntax</a></li>
<li><a href="02-gh-pages.html">Topic 3: Github Pages</a></li>
<li><a href="03-jekyll-setup.html">Topic 4: Jekyll Setup (optional)</a></li>
<li><a href="04-site-structure.html">Topic 5: Site Structure</a></li>
<li><a href="05-changing-theme.html">Topic 6: Changing your site theme</a></li>
<li><a href="mailto:authorcarpentry@library.caltech.edu">Contact Us</a></li>
</ul>
</nav>
<section>
<h1>Author Carpentry : Using Markdown and github to author for web and print</h1>
<p><em>Content Contributors: Sebastian Karcher</em></p>
<p><em>Lesson Maintainers: Sebastian Karcher</em></p>
<p><strong>Lesson status: In Development</strong></p>
<h2>Learning Objectives:</h2>
<ul>
<li>Using Jekyll to transform markdown into webpages</li>
<li>Creating a github page with simple navigation
-
<!--- Setting up a workflow to create both html and PDF/ebook version --></li>
</ul>
<h2>What you will learn:</h2>
<ol>
<li><a href="00-getting-started.html">Topic 1: Getting Started</a></li>
<li><a href="01-markdown-syntax.html">Topic 2: Markdown Syntax</a></li>
<li><a href="02-gh-pages.html">Topic 3: Github Pages</a></li>
<li><a href="03-jekyll-setup.html">Topic 4: Jekyll Setup (optional)</a></li>
<li><a href="04-site-structure.html">Topic 5: Site Structure</a></li>
<li><a href="05-changing-theme.html">Topic 6: Changing your site theme</a></li>
</ol>
<!--### Optional
- [Topic 5](04-services.html) -->
<h2>Requirements</h2>
<p>Author Carpentry’s teaching is hands-on, so participants are encouraged to use
their own computers to insure the proper setup of tools for an efficient
workflow.
<em>These lessons assume no prior knowledge of the skills or tools</em>, but working
through this lesson requires working copies of the software described below.
To most effectively use these materials, please make sure to install everything
<em>before</em> working through this lesson.</p>
<ol>
<li>Create a github account if you do not have one already
<ul>
<li>Go to <a href="https://github.com">github.com</a> and pick a username and password to create an account</li>
</ul></li>
<li><p>For Windows users: Install git via <a href="https://git-scm.com/download/win">https://git-scm.com/download/win</a></p>
<ul>
<li>If you have never run git (you can check using <code>git config --list</code>) you need to set up your username and e-mail:</li>
<li>Either follow the detailed instruction on the <a href="http://swcarpentry.github.io/git-novice/02-setup/">Software Carpentry</a> site or simply run:
<br /></li>
</ul>
<pre><code>$ git config --global user.name "Your Username"
$ git config --global user.email "your@email.edu"
$ git config --global color.ui "auto"
</code></pre></li>
<li><p>You should have a good text editor. <a href="http://atom.io/">Atom</a> is a free an open source editor with excellent markdown support that we highly recommend you install and use, and some portions of this course rely on atom.</p>
<ul>
<li>Atom is highly extensible with “packages” that add functionality. For markdown, install the package <em>Markdown Preview Plus</em>:</li>
<li>Click “Install a Package” or go to Edit –> Preferences (Atom -> Preferences on a mac) and click on “Install” on the left. Paste <code>markdown-preview-plus</code> into the search window, press return, and click the blue “Install” button next to the package. On successful installation, you will have the package listed in the “Package” menu.</li>
<li>Paste <code>git-plus</code> into the search window, press return, and click the blue “Install” button next to the package. (Not git-plus-plus) On successful installation, you will have the package listed in the “Package” menu.</li>
<li>If you do not want to install atom, many other good editors such as TextWrangler/BBEdit, Sublime, or Notepad++ work, too. There are also great online editors such as <a href="https://hackmd.io/">hackmd</a>, and <a href="http://dillinger.io/">Dillinger</a> though we suggest you use a local tool here.</li>
</ul></li>
<li><p>Optional: While we will default to git in atom / command line for this lesson,
consider installing the github desktop app from <a href="https://desktop.github.com/">https://desktop.github.com/</a></p></li>
</ol>
<h2>Cheat Sheet</h2>
<h2>References</h2>
</section>
<footer>
<span>© Lesson Contributors</span>
<span><a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img
alt="Creative Commons License" style="vertical-align: middle;"
src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a></span>
<span>This work is licensed under a <a rel="license"
href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution
4.0 International License</a></span>
</footer>
</body>
</html>