Skip to content

Commit

Permalink
Update formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
leojakeson authored Jul 9, 2021
1 parent 85aa636 commit 1c4f3df
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions tutorial-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,19 @@ Example terminology that you can use in the tutorial:
* Client private: `<198.51.100.1>` and `<2001:db8:9abc::1>`
* Client public: `<203.0.113.1>` and `<2001:db8:5678::1>`

## Step 1 - <Summary of Step>
## Step 1 - `<Summary of Step>`

Steps are the actual steps users will be taking to complete your tutorial.

Each step should build on the previous one, until the final step that finishes the tutorial.

It is important not to skip any steps, no matter how obvious or self-explanatory they may seem.

Feel free to include screenshots, to show exactly what the user should be seeing. Please put screenshots in a separate "images" folder.

The amount of steps will depend entirely on how long/complicated the tutorial is.

## Step 2 - <Summary of Step>
## Step 2 - `<Summary of Step>`

Quick introduction.

Expand All @@ -59,7 +63,7 @@ Then...

Finally...

### Step 2.1 - <Summary of Step>
### Step 2.1 - `<Summary of Step>`

Here is a code example

Expand All @@ -68,7 +72,7 @@ var s = "JavaScript syntax highlighting";
alert(s);
```

### Step 2.2 - <Summary of Step>
### Step 2.2 - `<Summary of Step>`

Another code example

Expand All @@ -77,11 +81,11 @@ s = "Python syntax highlighting"
print s
```

## Step 3 - <Summary of Step> (Optional)
## Step 3 - `<Summary of Step> (Optional)`

More instructions.
Instructions for a step that is not necessary to complete the tutorial, but can be helpful.

## Step N - <Summary of Step>
## Step N - `<Summary of Step>`

Yet more instructions.

Expand Down

0 comments on commit 1c4f3df

Please sign in to comment.