summaryrefslogtreecommitdiffhomepage
path: root/markdown.html.markdown
diff options
context:
space:
mode:
authorJacob Ward <jacobward1898@gmail.com>2015-10-30 08:32:32 -0600
committerJacob Ward <jacobward1898@gmail.com>2015-10-30 08:32:32 -0600
commit71ee28e132fbbade39568fb2332b10e81c07f68a (patch)
treec3d25643b0cfb8cc2a81b6269a54055e4f92ae7b /markdown.html.markdown
parentbb006a51c12e59ba215a7eab340bbbac8d024278 (diff)
easier to read?
Diffstat (limited to 'markdown.html.markdown')
-rw-r--r--markdown.html.markdown45
1 files changed, 28 insertions, 17 deletions
diff --git a/markdown.html.markdown b/markdown.html.markdown
index 2333110f..8b218473 100644
--- a/markdown.html.markdown
+++ b/markdown.html.markdown
@@ -2,45 +2,53 @@
language: markdown
contributors:
- ["Dan Turkel", "http://danturkel.com/"]
+ - ["Jacob Ward", "http://github.com/JacobCWard/"]
filename: markdown.md
---
-Markdown was created by John Gruber in 2004. It's meant to be an easy to read and write syntax which converts easily to HTML (and now many other formats as well).
-
-Give me as much feedback as you want! / Feel free to fork and pull request!
+Markdown was created by John Gruber in 2004. It's meant to be an easy to read and write syntax which converts easily to HTML (and now many other formats as well).
-```markdown
-<!-- Markdown is a superset of HTML, so any HTML file is valid Markdown, that
+Markdown is a superset of HTML, so any HTML file is valid Markdown, that
means we can use HTML elements in Markdown, such as the comment element, and
they won't be affected by a markdown parser. However, if you create an HTML
element in your markdown file, you cannot use markdown syntax within that
-element's contents. -->
+element's contents.
-<!-- Markdown also varies in implementation from one parser to a next. This
+Markdown also varies in implementation from one parser to a next. This
guide will attempt to clarify when features are universal or when they are
-specific to a certain parser. -->
+specific to a certain parser.
+
+- [Headings](#headings)
+- [Simple Text Styles](#simple-text-styles)
-<!-- Headers -->
-<!-- You can create HTML elements <h1> through <h6> easily by prepending the
-text you want to be in that element by a number of hashes (#) -->
+## Headings
+
+You can create HTML elements `<h1>` through `<h6>` easily by prepending the
+text you want to be in that element by a number of hashes (#).
+
+```markdown
# This is an <h1>
## This is an <h2>
### This is an <h3>
#### This is an <h4>
##### This is an <h5>
###### This is an <h6>
+```
+Markdown also provides us with two alternative ways of indicating h1 and h2.
-<!-- Markdown also provides us with two alternative ways of indicating h1 and h2 -->
+```markdown
This is an h1
=============
This is an h2
-------------
+```
+## Simple text styles
-<!-- Simple text styles -->
-<!-- Text can be easily styled as italic or bold using markdown -->
+Text can be easily styled as italic or bold using markdown.
+```markdown
*This text is in italics.*
_And so is this text._
@@ -50,10 +58,11 @@ __And so is this text.__
***This text is in both.***
**_As is this!_**
*__And this!__*
+```
-<!-- In Github Flavored Markdown, which is used to render markdown files on
-Github, we also have strikethrough: -->
-
+In Github Flavored Markdown, which is used to render markdown files on
+Github, we also have strikethrough:
+```markdown
~~This text is rendered with strikethrough.~~
<!-- Paragraphs are a one or multiple adjacent lines of text separated by one or
@@ -83,7 +92,9 @@ There's a <br /> above me!
> You can also use more than one level
>> of indentation?
> How neat is that?
+```
+```markdown
<!-- Lists -->
<!-- Unordered lists can be made using asterisks, pluses, or hyphens -->