Skip to content
This repository was archived by the owner on Apr 2, 2024. It is now read-only.

Commit e0b6f49

Browse files
tbekolaytbekolay
committed
Implementation of Greg Wilson's template
This is up for discussion, but at the moment is the minimal set of files needed to be a Software Carpentry lesson.
0 parents  commit e0b6f49

21 files changed

+639
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.DS_Store
2+
_site/

‎01-one.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: topic
3+
title: Topic One
4+
minutes: 30
5+
---
6+
> ## Learning Objectives {.objectives}
7+
>
8+
> * Learning objective 1
9+
> * Learning objective 2
10+
11+
Paragraphs of text mixed with:
12+
13+
~~~ {.python}
14+
some code:
15+
to be displayed
16+
~~~
17+
~~~ {.output}
18+
output
19+
from
20+
program
21+
~~~
22+
~~~ {.error}
23+
error reports from program (if any)
24+
~~~
25+
26+
and possibly including:
27+
28+
> ## Callout Box {.callout}
29+
>
30+
> An aside of some kind.
31+
32+
> ## Challenge Title {.challenge}
33+
>
34+
> Description of a single challenge.
35+
> There may be several challenges.

‎02-two.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: topic
3+
title: Topic Two
4+
minutes: 45
5+
---
6+
> ## Learning Objectives {.objectives}
7+
>
8+
> * Learning objective 1
9+
> * Learning objective 2
10+
11+
Paragraphs of text mixed with:
12+
13+
~~~ {.python}
14+
some code:
15+
to be displayed
16+
~~~
17+
~~~ {.output}
18+
output
19+
from
20+
program
21+
~~~
22+
~~~ {.error}
23+
error reports from program (if any)
24+
~~~
25+
26+
and possibly including:
27+
28+
> ## Callout Box {.callout}
29+
>
30+
> An aside of some kind.
31+
32+
> ## Challenge Title {.challenge}
33+
>
34+
> Description of a single challenge.
35+
> There may be several challenges.

‎LICENSE.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
layout: lesson
3+
title: Licenses
4+
---
5+
### Instructional Material
6+
7+
All Software Carpentry instructional material is made available under
8+
the Creative Commons Attribution license. You are free:
9+
10+
* to **Share**---to copy, distribute and transmit the work
11+
* to **Remix**---to adapt the work
12+
13+
Under the following conditions:
14+
15+
* **Attribution**---You must attribute the work using "Copyright (c)
16+
Software Carpentry" (but not in any way that suggests that we
17+
endorse you or your use of the work). Where practical, you must
18+
also include a hyperlink to http://software-carpentry.org.
19+
20+
With the understanding that:
21+
22+
* **Waiver**---Any of the above conditions can be waived if you get
23+
permission from the copyright holder.
24+
* **Other Rights**---In no way are any of the following rights
25+
affected by the license:
26+
* Your fair dealing or fair use rights;
27+
* The author's moral rights;
28+
* Rights other persons may have either in the work itself or in
29+
how the work is used, such as publicity or privacy rights. *
30+
* **Notice**---For any reuse or distribution, you must make clear to
31+
others the license terms of this work. The best way to do this is
32+
with a link to
33+
[http://creativecommons.org/licenses/by/3.0/](http://creativecommons.org/licenses/by/3.0/).
34+
35+
For the full legal text of this license, please see
36+
[http://creativecommons.org/licenses/by/3.0/legalcode](http://creativecommons.org/licenses/by/3.0/legalcode).
37+
38+
### Software
39+
40+
Except where otherwise noted, the example programs and other software
41+
provided by Software Carpentry are made available under the
42+
[OSI](http://opensource.org)-approved
43+
[MIT license](http://opensource.org/licenses/mit-license.html).
44+
45+
Permission is hereby granted, free of charge, to any person obtaining
46+
a copy of this software and associated documentation files (the
47+
"Software"), to deal in the Software without restriction, including
48+
without limitation the rights to use, copy, modify, merge, publish,
49+
distribute, sublicense, and/or sell copies of the Software, and to
50+
permit persons to whom the Software is furnished to do so, subject to
51+
the following conditions:
52+
53+
The above copyright notice and this permission notice shall be
54+
included in all copies or substantial portions of the Software.
55+
56+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
57+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
58+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
59+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
60+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
61+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
62+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
63+
64+
### Other Material
65+
66+
Our [code of conduct](CODE_OF_CONDUCT.html) is taken from
67+
[this site](https://github.com/Bantik/contributor_covenant/blob/master/LICENSE),
68+
and is made available under the same MIT License as our software.
69+
70+
### Trademark
71+
72+
"Software Carpentry" and the Software Carpentry logo are registered
73+
trademarks of Software Carpentry, Ltd.

‎_config.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
markdown : kramdown
2+
kramdown :
3+
entity_output : as_input # — is output as —
4+
smart_quotes : [39, 39, 34, 34] # decimal for left/right single/double quotes
5+
contact : "[email protected]"
6+
github_url : "https://github.com/swcarpentry"
7+
irc_url : "irc://moznet/sciencelab"
8+
rss_url : "http://software-carpentry.org/feed.xml"
9+
swc_prefix : "http://software-carpentry.org"
10+
twitter_name : "@swcarpentry"
11+
twitter_url : "https://twitter.com/swcarpentry"

‎_includes/banner.html

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<span id="github-ribbon"><a href="https://github.com/swcarpentry/bc">Fork me on GitHub</a></span>
2+
<div class="banner">
3+
<a href="http://software-carpentry.org" title="Software Carpentry">
4+
<img alt="Software Carpentry banner" src="http://software-carpentry.org/v5/img/software-carpentry-banner.png" />
5+
</a>
6+
</div>

‎_includes/footer.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<div class="footer">
2+
<a class="label swc-blue-bg" href="mailto:{{site.contact}}">Email</a>
3+
<a class="label swc-blue-bg" href="{{site.twitter_url}}">Twitter</a>
4+
<a class="label swc-blue-bg" href="{{site.rss_url}}">RSS</a>
5+
<a class="label swc-blue-bg" href="{{site.github_url}}">GitHub</a>
6+
<a class="label swc-blue-bg" href="{{site.irc_url}}">IRC</a>
7+
<a class="label swc-blue-bg" href="/LICENSE.html">License</a>
8+
<a class="bugreport label swc-blue-bg" href="mailto:{{site.contact}}?subject=bug%20in%20{{page.path}}">Bug Report</a>
9+
</div>

‎_includes/header.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
2+
<link href="http://software-carpentry.org/v5/css/bootstrap/bootstrap.css" rel="stylesheet" />
3+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
4+
<link href="http://software-carpentry.org/v5/css/bootstrap/bootstrap-responsive.css" rel="stylesheet" />
5+
<link rel="stylesheet" type="text/css" href="http://software-carpentry.org/v5/css/swc.css" />
6+
<link rel="stylesheet" type="text/css" href="http://software-carpentry.org/v5/css/swc-bootstrap.css" />
7+
<link rel="alternate" type="application/rss+xml" title="The Software Carpentry Blog" href="http://software-carpentry.org/feed.xml"/>
8+
<meta charset="UTF-8" />
9+
<meta http-equiv="last-modified" content="{{site.timestamp}}" />
10+
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
11+
<!--[if lt IE 9]>
12+
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
13+
<![endif]-->

‎_includes/javascript.html

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!-- Le javascript
2+
================================================== -->
3+
<!-- Placed at the end of the document so the pages load faster -->
4+
<script src="http://software-carpentry.org/v5/js/jquery-1.9.1.min.js"></script>
5+
<script src="http://software-carpentry.org/v5/js/bootstrap/bootstrap.min.js"></script>

‎_layouts/lesson.html

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
---
3+
<!DOCTYPE html>
4+
<html>
5+
<head>
6+
{% if page.title %}
7+
<title>{{ page.title }}</title>
8+
{% endif %}
9+
{% include header.html %}
10+
<link rel="stylesheet" type="text/css" href="http://software-carpentry.org/v5/css/lesson.css" />
11+
</head>
12+
<body>
13+
<div class="container">
14+
{% include banner.html %}
15+
16+
<div class="row-fluid">
17+
<div class="span10 offset1">
18+
<!-- start content -->
19+
{% if page.title %}
20+
<h1>{{page.title}}</h1>
21+
{% endif %}
22+
{{content}}
23+
<!-- end content -->
24+
</div>
25+
</div>
26+
27+
{% include footer.html %}
28+
</div>
29+
{% include javascript.html %}
30+
</body>
31+
</html>

‎_layouts/reference.html

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
---
3+
<!DOCTYPE html>
4+
<html>
5+
<head>
6+
{% if page.title %}
7+
<title>{{ page.title }}</title>
8+
{% endif %}
9+
{% include header.html %}
10+
<link rel="stylesheet" type="text/css" href="http://software-carpentry.org/v5/css/lesson.css" />
11+
</head>
12+
<body>
13+
<div class="container">
14+
{% include banner.html %}
15+
16+
<div class="row-fluid">
17+
<div class="span10 offset1">
18+
<!-- start content -->
19+
{% if page.title %}
20+
<h1>{{page.title}}</h1>
21+
{% endif %}
22+
{{content}}
23+
<!-- end content -->
24+
</div>
25+
</div>
26+
27+
{% include footer.html %}
28+
</div>
29+
{% include javascript.html %}
30+
</body>
31+
</html>

0 commit comments

Comments
 (0)