Recipe Template
Title/recipe name - Short, and task orientated
Introduction - heading and text block to orientate the user, provide an intial mental model. may inclide images.
Headings - Informative subgoals 2 levels - Goal, subgoal
Step 1
Also Step 1
Step 2
Step 3
Note - supplimentary information (non critical) that immediately follows a step or substep. heading with text and/or image.
Caution - Warning info that may preceed or immediately follow a step or substep. Heading with text and/or image.
Figure - image that shows graphical instruction or locations
Figure caption - text, numbered… title and description for figure.
Code fragment -
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.
@echo - the text a user should type (almost exactly) into the terminal/window @echo variable - the text a user needs to type, but substitite with their own local information (username etc..)
Table - self explanatory. html can do this.
Table caption - self explanatory.
- Footer
-
License . CC snippet to contain licence text, image, link.
- Author . Name, link, @handle
- Version . date, v, (datetime, text field)
You’ll find this post in your _posts
directory - edit this post and re-build (or run with the -w
switch) to see your changes!
To add new posts, simply add a file in the _posts
directory that follows the convention: YYYY-MM-DD-name-of-post.ext.
Jekyll also offers powerful support for code snippets:
Check out the Jekyll docs for more info on how to get the most out of Jekyll. File all bugs/feature requests at Jekyll’s GitHub repo.