--- # this is so called 'Yaml Front Matter', read up on it here: http://jekyllrb.com/docs/frontmatter/ layout: pattern # layout must always be pattern title: Best Pattern Ever # the properly formatted title folder: best-pattern-ever # the folder name in which this pattern lies permalink: /patterns/best-pattern-ever/ # the permalink to the pattern, to keep this uniform please stick to /patterns/FOLDER/ description: # short meta description that shows in Google search results
both categories and tags are Yaml Lists
you can either just pick one or write a list with '-'s
usable categories and tags are listed here: https://github.com/iluwatar/java-design-patterns/blob/gh-pages/_config.yml
categories: creational # categories of the pattern tags: # tags of the pattern
- best
- ever
- awesome
Name / classification
...
Also known as
...
Intent
...
Explanation
...
Class diagram
...
Applicability
...
Tutorials
...
Known uses
...
Consequences (the good and the bad, add criticism here)
...
Related patterns
...
Credits
...