Skip to content

Commit f9ab992

Browse files
committed
first commit
0 parents  commit f9ab992

File tree

149 files changed

+1469
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

149 files changed

+1469
-0
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
json
2+
public-site

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# tutors-starter
2+
3+
A starter course structure for the tutors generator. This course is deployed here:
4+
5+
- <https://tutors-design.netlify.app/course/starter-three.netlify.app>
6+
7+
A local static version of the course can be built as follows:
8+
9+
```
10+
https://github.com/tutors-sdk/starter-three.git
11+
npx tutors-html
12+
```
13+
14+
This will generate a web site in ./public-site.
15+
16+
To deploy the course using [tutors-design](https://github.com/edeleastar/tutors-design), clone this repo to your own github or bitbucket account, and follow [this lab step here](https://tutors-design.netlify.app/lab/tutors-course.netlify.app/topic-00-tutors-next/book-next/03).

course.jpg

44 KB
Loading

course.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Tutors Starter Three
2+
3+
A short description of the course. Normally this will not be visible, unless the course is aggregated into a portfolio of modules

package.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"dependencies": {
3+
"tutors-json": "^1"
4+
}
5+
}

properties.yaml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
slack: https://tutors-ts-group.slack.com/messages/CCKS0HR0Q
2+
moodle: https://moodle.wit.ie/course/view.php?id=118143&section=3
3+
youtube: https://www.youtube.com/playlist?list=PLMW4bgOfD3Dwi6FWirJ3AQtXZ-N_hV3Eo
4+
zoom: https://zoom.us/
5+
credits: Your Name Here, WIT
6+
auth : 0
7+
ignorepin : 1234
8+

topic-01/topic.jpg

65.9 KB
Loading

topic-01/topic.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Simple Units
2+
3+
This topic has 2 units - each unit has lectures + lab

topic-01/unit-1/book-a/00.Lab-01.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Objectives
2+
3+
A few sentences on the purpose of the lab. Avoid bullet points here for formatting reasons.

topic-01/unit-1/book-a/01.01.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Text
2+
3+
It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [inset a link to Google](http://google.com)
4+
5+
6+
## Lists
7+
8+
Sometimes you want numbered lists:
9+
10+
1. One
11+
2. Two
12+
3. Three
13+
14+
Sometimes you want bullet points:
15+
16+
* Start a line with a star
17+
* Profit!
18+
19+
Alternatively,
20+
21+
- Dashes work just as well
22+
- And if you have sub points, put two spaces before the dash or star:
23+
- Like this
24+
- And this
25+
26+
## Images
27+
28+
If you want a link to a local image, place the image in the `img` folder and then insert a link like this:
29+
30+
![](img/02.jpg)
31+
32+
Alternatively you can directly link to images on the web:
33+
34+
![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)
35+
36+
The above includes a title.
37+
38+
# Structured documents
39+
40+
Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.
41+
42+
### This is a third-tier heading
43+
44+
You can use one `#` all the way up to `######` six for different heading sizes.
45+
46+
If you'd like to quote someone, use the > character before the line:
47+
48+
> Coffee. The finest organic suspension ever devised... I beat the Borg with it.
49+
> - Captain Janeway
50+
51+
There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: `var example = true`. If you've got a longer block of code, you can indent with four spaces:
52+
53+
if (isAwesome){
54+
return true
55+
}
56+
57+
GitHub also supports something called code fencing, which allows for multiple lines without indentation:
58+
59+
~~~
60+
if (isAwesome){
61+
return true
62+
}
63+
~~~
64+
65+
And if you'd like to use syntax highlighting, include the language:
66+
67+
~~~javascript
68+
if (isAwesome){
69+
return true
70+
}
71+
~~~
72+

topic-01/unit-1/book-a/02.02.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Tables, Lines and Images
2+
3+
4+
Tables can look like this:
5+
6+
Head 1 | Head 2
7+
------ | -------
8+
cell 1 | cell 2
9+
cell 3 | cell 4
10+
11+
12+
---
13+
14+
A horizontal rules above and below
15+
16+
---
17+
18+
Some more images:
19+
20+
![](img/01.jpg)

topic-01/unit-1/book-a/03.03.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Links and Code Blocks
2+
3+
You can inert links in bullet points:
4+
5+
- <http://github.com>
6+
- <http://bitbucket.dom>
7+
8+
You can also insert links to other steps:
9+
10+
- [Step 01](#/01)
11+
- [Step 02](#/02)
12+
- [Step 03](#/03)
13+
- [Step 04](#/04)
14+
15+
More Code Block examples
16+
17+
~~~
18+
publish(path, course) {
19+
const basePath = '../' + path + '/' + this.folder;
20+
futils.initEmptyPath(basePath);
21+
22+
this.resources = this.talks.concat(this.labs);
23+
futils.copyFileToFolder(this.img, basePath);
24+
futils.writeFile(basePath + '/index.html', nunjucks.render('topic.html', this));
25+
26+
futils.writeFile(basePath + '/ajaxlabel.html',
27+
nunjucks.render('ajaxlabel.html',
28+
{ url: this.url.substring(5) + '/' + this.folder }));
29+
futils.writeFile(basePath + '/indexmoodle.html', nunjucks.render('indexmoodle.html', this));
30+
31+
console.log(this.title);
32+
this.publishTalks(basePath);
33+
this.publishLabs(basePath, course);
34+
}
35+
~~~
36+
37+
This was autodetected as javascript. This one is html:
38+
39+
~~~
40+
<div class="ui segment pushable">
41+
<div class="ui inverted labeled icon left inline vertical sidebar menu">
42+
{% for resource in course.allLabs.resources %}
43+
{% if resource.title == title %}
44+
<a class="active item" href="../../{{resource.parentFolder}}/{{resource.folder}}/{{resource.link}}">
45+
{{resource.title}}
46+
</a>
47+
{% else %}
48+
<a class="item" href="../../{{resource.parentFolder}}/{{resource.folder}}/{{resource.link}}">
49+
{{resource.title}}
50+
</a>
51+
{% endif %}
52+
{% endfor %}
53+
</div>
54+
<div class="pusher">
55+
<div class="ui basic segment">
56+
<br>
57+
{% for chapter in chapters %}
58+
<div class="ui tab segment lab" data-tab="{{chapter.shortTitle}}">
59+
{{ chapter.content }}
60+
</div>
61+
{% endfor %}
62+
</div>
63+
</div>
64+
</div>
65+
~~~

topic-01/unit-1/book-a/04.04.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Images
2+
3+
Image without a title:
4+
5+
![](img/04.jpg)
6+
7+
Image with a title:
8+
9+
![This is a Stone Arch](img/03.jpg)

topic-01/unit-1/book-a/05.05.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Katex
2+
3+
Larex support via the [Katex](https://katex.org/) Library.
4+
5+
## Example 0
6+
7+
```asciimath
8+
E=mc^2
9+
```
10+
11+
## Example 1
12+
13+
```latex
14+
c = \pm\sqrt{a^2 + b^2}
15+
```
16+
17+
## Example 2
18+
19+
20+
```latex
21+
x=\frac{ -b\pm\sqrt{ b^2-4ac } } {2a}
22+
```
23+
24+
## Example 3
25+
26+
27+
```latex
28+
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
29+
```
30+
31+
## Example 4
32+
33+
34+
```asciimath
35+
g(x) = 3x^4 + 2x^2
36+
```
37+
38+
## Example 5
39+
40+
41+
```latex
42+
43+
x=\frac{ -b\pm\sqrt{ b^2-4ac } } {2a}
44+
45+
\sum_{i=1}^n i^3 = \left( \frac{n(g(n)+1)} 2 \right) ^2
46+
47+
c = \pm\sqrt{a^2 + b^2}
48+
```
49+
50+
## Example 6
51+
52+
~~~latex
53+
54+
\frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }
55+
56+
~~~
57+
58+
## Example 7
59+
60+
~~~latex
61+
1 + \frac{q^2}{(1-q)}+\frac{q^6}{(1-q)(1-q^2)}+\cdots = \prod_{j=0}^{\infty}\frac{1}{(1-q^{5j+2})(1-q^{5j+3})}, \quad\quad \text{for }\lvert q\rvert<1.
62+
~~~
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Exercises & Archives
2+
3+
You can link to zipped archives:
4+
5+
- [Solutions](./archives/archive.zip)
6+
7+
This archive must be placed in the `archives` folder as shown above.
8+
9+
## Exercise 1:
10+
11+
Instructions for exercise 1.
12+
13+
## Exercise 2:
14+
15+
Instructions for exercise 2.
16+
17+
## Exercise 3:
18+
19+
Instructions for exercise 3.
516 KB
Binary file not shown.

topic-01/unit-1/book-a/img/01.jpg

18.6 KB
Loading

topic-01/unit-1/book-a/img/02.jpg

16.6 KB
Loading

topic-01/unit-1/book-a/img/03.jpg

57 KB
Loading

topic-01/unit-1/book-a/img/04.jpg

40.3 KB
Loading

topic-01/unit-1/book-a/img/main.png

8.33 KB
Loading

topic-01/unit-1/talk-1/talk-1.jpg

13.1 KB
Loading

topic-01/unit-1/talk-1/talk-1.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Lecture 1
2+
3+
A short summary of the talk, no more than two sentences. Avoid bullet points or links for formatting reasons.

topic-01/unit-1/talk-1/talk-1.pdf

1.21 MB
Binary file not shown.

topic-01/unit-1/talk-2/talk-2.jpg

61 KB
Loading

topic-01/unit-1/talk-2/talk-2.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Lecture 2
2+
3+
A short summary of the talk, no more than two sentences. Avoid bullet points or links for formatting reasons.

topic-01/unit-1/talk-2/talk-2.pdf

1.21 MB
Binary file not shown.

topic-01/unit-1/topic.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Unit 1 Title

topic-01/unit-2/book-a/00.Lab-02.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Objectives
2+
3+
A few sentences on the purpose of the lab. Avoid bullet points here for formatting reasons.

topic-01/unit-2/book-a/01.01.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Text
2+
3+
It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [inset a link to Google](http://google.com)
4+
5+
## Lists
6+
7+
Sometimes you want numbered lists:
8+
9+
1. One
10+
2. Two
11+
3. Three
12+
13+
Sometimes you want bullet points:
14+
15+
* Start a line with a star
16+
* Profit!
17+
18+
Alternatively,
19+
20+
- Dashes work just as well
21+
- And if you have sub points, put two spaces before the dash or star:
22+
- Like this
23+
- And this
24+
25+
## Images
26+
27+
If you want a link to a local image, place the image in the `img` folder and then insert a link like this:
28+
29+
![](img/02.jpg)
30+
31+
Alternatively you can directly link to images on the web:
32+
33+
![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)
34+
35+
The above includes a title.
36+
37+
# Structured documents
38+
39+
Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.
40+
41+
### This is a third-tier heading
42+
43+
You can use one `#` all the way up to `######` six for different heading sizes.
44+
45+
If you'd like to quote someone, use the > character before the line:
46+
47+
> Coffee. The finest organic suspension ever devised... I beat the Borg with it.
48+
> - Captain Janeway
49+
50+
There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: `var example = true`. If you've got a longer block of code, you can indent with four spaces:
51+
52+
if (isAwesome){
53+
return true
54+
}
55+
56+
GitHub also supports something called code fencing, which allows for multiple lines without indentation:
57+
58+
~~~
59+
if (isAwesome){
60+
return true
61+
}
62+
~~~
63+
64+
And if you'd like to use syntax highlighting, include the language:
65+
66+
~~~javascript
67+
if (isAwesome){
68+
return true
69+
}
70+
~~~
71+

0 commit comments

Comments
 (0)