Skip to content

Commit 0de4d3f

Browse files
committed
restructure for prerequisits
1 parent 57a42b6 commit 0de4d3f

15 files changed

Lines changed: 169 additions & 23 deletions

docs/tut/1-0-tools.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
layout: default
3+
title: 1. Tools for git
4+
nav_order: 1
5+
parent: Tutorials
6+
has_children: true
7+
---
8+
9+
10+
# Tools for working with git
11+
{: .fs-8 }
12+
13+
Some essential tools for working with git and GitHub to create and contribute to documentation
14+
{: .fs-6 .fw-300 }
15+
16+
<!-- --- -->
Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
---
22
layout: default
3-
title: 1. Using Atom
3+
title: 1.1 Command line
44
nav_order: 1
5-
parent: Tutorials
5+
grand_parent: Tutorials
6+
parent: 1. Tools for git
67
has_children: false
78
---
89

910

10-
# Using Atom
11+
# Atom text editor
1112
{: .fs-8 }
1213

13-
How to set up and use Atom from writing markdown
14+
How to set up and use Atom for writing markdown
1415
{: .fs-6 .fw-300 }
1516

1617
---

docs/tut/1-2-markdown.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: default
3+
title: 1.2 Markdown
4+
nav_order: 2
5+
grand_parent: Tutorials
6+
parent: 1. Tools for git
7+
has_children: false
8+
---
9+
10+
11+
# Atom text editor
12+
{: .fs-8 }
13+
14+
How to set up and use Atom for writing markdown
15+
{: .fs-6 .fw-300 }
16+
17+
---
18+
19+
![logo-atom](../../img/atom-200.png)
20+
21+
Atom is my fave editor for all types of "code". Python, bash, markdown, html... I've not tried with LaTeX, but I wouldn't be surprised if it can handle that. My guess is it probably can't handle MATLAB, but that's cool.
22+
23+
## Why I love Atom
24+
25+
What I particularly love about Atom is that I can switch between different languages very comfortably), and Atom takes care of everything the same way, no matter what you are writing. It handles the colours, the spacing, the formatting, [linting](https://en.wikipedia.org/wiki/Lint_(software)), the keyboard shortcuts, autocompletions, commenting, spell checking, searching / find+replace across multiple files, all the important stuff! I guess that is what you get from an open source tool developed by and for users who write code for a living! Other tools are available which I'm sure do a great job, but this is the one I am most comfortable with and consistently pleased by.
26+
27+
## Why you should use Atom
28+
29+
To host your documentation on GitHub pages, you're going to be writing across multiple documents, and potentially in more than one language. Atom also has a directory tree on the left which enables you to navigate around your project file easily, and also do things like create, duplicate and delete files using good old point-and-click.
30+
31+
Atom also provides a graphical point-and-click way of committing changes to your GitHub repo. This can be useful if you're not familiar with the process, but for these tutorials we're going to stick to command line and the terminal for GitHub, because you get more informative error reports.
32+
33+
## How to start with Atom
34+
35+
Before we crack on with creating and editing documentation, I'd love for you to get familiar with working in Atom. Here's a short video which shows you how to [install and start using Atom](https://www.youtube.com/watch?v=EyG20hhON6E).
36+
37+
There are tones of packages you can add on to make your workflow easier, but for these tutorials you'll only need the markdown basics which come preloaded.
38+
39+
Thanks, Atom. We love ya.

docs/tut/1-3-atom.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
layout: default
3+
title: 1.3 Atom text editor
4+
nav_order: 3
5+
grand_parent: Tutorials
6+
parent: 1. Tools for git
7+
has_children: false
8+
---
9+
10+
11+
# Atom text editor
12+
{: .fs-8 }
13+
14+
How to set up and use Atom for writing markdown
15+
{: .fs-6 .fw-300 }
16+
17+
---
18+
19+
![logo-atom](../../img/atom-200.png)
20+
21+
Atom is my fave editor for all types of "code". Python, bash, markdown, html... I've not tried with LaTeX, but I wouldn't be surprised if it can handle that. My guess is it probably can't handle MATLAB, but that's cool.
22+
23+
## Why I love Atom
24+
25+
What I particularly love about Atom is that I can switch between different languages very comfortably), and Atom takes care of everything the same way, no matter what you are writing. It handles the colours, the spacing, the formatting, [linting](https://en.wikipedia.org/wiki/Lint_(software)), the keyboard shortcuts, autocompletions, commenting, spell checking, searching / find+replace across multiple files, all the important stuff! I guess that is what you get from an open source tool developed by and for users who write code for a living! Other tools are available which I'm sure do a great job, but this is the one I am most comfortable with and consistently pleased by.
26+
27+
## Why you should use Atom
28+
29+
To host your documentation on GitHub pages, you're going to be writing across multiple documents, and potentially in more than one language. Atom also has a directory tree on the left which enables you to navigate around your project file easily, and also do things like create, duplicate and delete files using good old point-and-click.
30+
31+
Atom also provides a graphical point-and-click way of committing changes to your GitHub repo. This can be useful if you're not familiar with the process, but for these tutorials we're going to stick to command line and the terminal for GitHub, because you get more informative error reports.
32+
33+
## How to start with Atom
34+
35+
Before we crack on with creating and editing documentation, I'd love for you to get familiar with working in Atom. Here's a short video which shows you how to [install and start using Atom](https://www.youtube.com/watch?v=EyG20hhON6E).
36+
37+
There are tones of packages you can add on to make your workflow easier, but for these tutorials you'll only need the markdown basics which come preloaded.
38+
39+
Thanks, Atom. We love ya.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: default
3-
title: 2. Set up your GitHub
3+
title: 2. Starting with GitHub
44
nav_order: 2
55
parent: Tutorials
6-
has_children: false
6+
has_children: true
77
---
88

99

docs/tut/2-1-install-git.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: default
3+
title: 2.1 Install git
4+
nav_order: 1
5+
grand_parent: Tutorials
6+
parent: 2. Starting with GitHub
7+
has_children: false
8+
---
9+
10+
11+
# Install git
12+
{: .fs-8 }
13+
14+
Make your github account
15+
{: .fs-6 .fw-300 }
16+
17+
---
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: default
3+
title: 2.2 Configure git
4+
nav_order: 2
5+
grand_parent: Tutorials
6+
parent: 2. Starting with GitHub
7+
has_children: false
8+
---
9+
10+
11+
# Configure git (first time only)
12+
{: .fs-8 }
13+
14+
Make your github account
15+
{: .fs-6 .fw-300 }
16+
17+
---

docs/tut/2-3-github-account.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: default
3+
title: 2.3 GitHub account
4+
nav_order: 3
5+
grand_parent: Tutorials
6+
parent: 2. Starting with GitHub
7+
has_children: false
8+
---
9+
10+
11+
# Create a GitHub account
12+
{: .fs-8 }
13+
14+
Make your github account
15+
{: .fs-6 .fw-300 }
16+
17+
---
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
layout: default
3-
title: 3. Basic git
4-
nav_order: 3
5-
parent: Tutorials
3+
title: 2.4 Basic git commands
4+
nav_order: 4
5+
grand_parent: Tutorials
6+
parent: 2. Starting with GitHub
67
has_children: false
78
---
89

9-
1010
# Basic git commands
1111
{: .fs-8 }
1212

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
3-
title: 4. Contribute to docs
4-
nav_order: 4
3+
title: 3. Contribute to docs
4+
nav_order: 3
55
parent: Tutorials
66
has_children: false
77
---

0 commit comments

Comments
 (0)