From 84a1ae46c7bd98906b90e1ae0e8089382e95777f Mon Sep 17 00:00:00 2001 From: Jacob Ward Date: Sat, 31 Oct 2015 21:02:18 -0600 Subject: Made the rendered text more readable. I formatted the document so that the rendered page is more easily readable. (plus it also serves as even more of an example of how to use Markdown.) #meta --- markdown.html.markdown | 217 +++++++++++++++++++++++++++++-------------------- 1 file changed, 130 insertions(+), 87 deletions(-) (limited to 'markdown.html.markdown') diff --git a/markdown.html.markdown b/markdown.html.markdown index b956a5f2..f17c2b75 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 - +element's contents. - +specific to a certain parser. + +- [Headings](#headings) +- [Simple Text Styles](#simple-text-styles) + +## Headings - - +You can create HTML elements `

` through `

` easily by prepending the +text you want to be in that element by a number of hashes (#). + +```markdown # This is an

## This is an

### This is an

#### This is an

##### This is an

###### This is an
+``` +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 - - +Text can be easily styled as italic or bold using markdown. +```markdown *This text is in italics.* _And so is this text._ @@ -50,15 +58,20 @@ __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: +```markdown ~~This text is rendered with strikethrough.~~ +``` +## Paragraphs - +Paragraphs are a one or multiple adjacent lines of text separated by one or +multiple blank lines. +```markdown This is a paragraph. I'm typing in a paragraph isn't this fun? Now I'm in paragraph 2. @@ -66,16 +79,20 @@ I'm still in paragraph 2 too! I'm in paragraph three! +``` - +Should you ever want to insert an HTML
tag, you can end a paragraph +with two or more spaces and then begin a new paragraph. +```markdown I end with two spaces (highlight me to see them). There's a
above me! +``` - +Block quotes are easy and done with the > character. +```markdown > This is a block quote. You can either > manually wrap your lines and put a `>` before every line or you can let your lines get really long and wrap on their own. > It doesn't make a difference so long as they start with a `>`. @@ -84,9 +101,12 @@ There's a
above me! >> of indentation? > How neat is that? - - +``` + +## Lists +Unordered lists can be made using asterisks, pluses, or hyphens. +```markdown * Item * Item * Another item @@ -102,159 +122,182 @@ or - Item - Item - One last item +``` +Ordered lists are done with a number followed by a period. - - +```markdown 1. Item one 2. Item two 3. Item three +``` - +You don't even have to label the items correctly and markdown will still +render the numbers in order, but this may not be a good idea. +```markdown 1. Item one 1. Item two 1. Item three - - - +``` +(This renders the same as the above example) +You can also use sublists +```markdown 1. Item one 2. Item two 3. Item three * Sub-item * Sub-item 4. Item four +``` - +There are even task lists. This creates HTML checkboxes. +```markdown Boxes below without the 'x' are unchecked HTML checkboxes. - [ ] First task to complete. - [ ] Second task that needs done This checkbox below will be a checked HTML checkbox. - [x] This task has been completed +``` + +## Code blocks - - +You can indicate a code block (which uses the `` element) by indenting +a line with four spaces or a tab. +```markdown This is code So is this +``` - +You can also re-tab (or add an additional four spaces) for indentation +inside your code +```markdown my_array.each do |item| puts item end +``` - +Inline code can be created using the backtick character ` +```markdown John didn't even know what the `go_to()` function did! +``` - - +In Github Flavored Markdown, you can use a special syntax for code +```markdown \`\`\`ruby def foobar puts "Hello world!" end \`\`\` +``` - +The above text doesn't require indenting, plus Github will use syntax +highlighting of the language you specify after the \`\`\` - - +## Horizontal rule (`
`) +Horizontal rules are easily added with three or more asterisks or hyphens, +with or without spaces. +```markdown *** --- - - - **************** +``` - - +## Links -[Click me!](http://test.com/) - - +One of the best things about markdown is how easy it is to make links. Put +the text to display in hard brackets [] followed by the url in parentheses () +```markdown +[Click me!](http://test.com/) +``` +You can also add a link title using quotes inside the parentheses. +```markdown [Click me!](http://test.com/ "Link to Test.com") - - - +``` +Relative paths work too. +```markdown [Go to music](/music/). - - - +``` +Markdown also supports reference style links. +```markdown [Click this link][link1] for more info about it! [Also check out this link][foobar] if you want to. [link1]: http://test.com/ "Cool!" [foobar]: http://foobar.biz/ "Alright!" - - - - +There is also "implicit naming" which lets you use the link text as the id. +```markdown [This][] is a link. [this]: http://thisisalink.com/ +``` +But it's not that commonly used. - - - - - +## Images +Images are done the same way as links but with an exclamation point in front! +```markdown ![This is the alt-attribute for my image](http://imgur.com/myimage.jpg "An optional title") - - - +``` +And reference style works as expected. +```markdown ![This is the alt-attribute.][myimage] [myimage]: relative/urls/cool/image.jpg "if you need a title, it's here" +``` - - - +## Miscellany +### Auto-links +```markdown is equivalent to [http://testwebsite.com/](http://testwebsite.com/) +``` - - +### Auto-links for emails +```markdown +``` - - +### Escaping characters +```markdown I want to type *this text surrounded by asterisks* but I don't want it to be in italics, so I do this: \*this text surrounded by asterisks\*. +``` - - +### Keyboard keys +In Github Flavored Markdown, you can use a tag to represent keyboard keys. +```markdown Your computer crashed? Try sending a Ctrl+Alt+Del +``` +### Tables - - - +Tables are only available in Github Flavored Markdown and are slightly +cumbersome, but if you really want it: +```markdown | Col1 | Col2 | Col3 | | :----------- | :------: | ------------: | | Left-aligned | Centered | Right-aligned | | blah | blah | blah | +``` +or, for the same results - - +```markdown Col 1 | Col2 | Col3 :-- | :-: | --: Ugh this is so ugly | make it | stop - - - ``` - +--- For more info, check out John Gruber's official post of syntax [here](http://daringfireball.net/projects/markdown/syntax) and Adam Pritchard's great cheatsheet [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). -- cgit v1.2.3 From cf9c94934533dbd3c96ac35d94bc88e50154c7ac Mon Sep 17 00:00:00 2001 From: Jacob Ward Date: Sat, 31 Oct 2015 21:09:58 -0600 Subject: in-page navigational links added links to the various sections of the document --- markdown.html.markdown | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'markdown.html.markdown') diff --git a/markdown.html.markdown b/markdown.html.markdown index f17c2b75..7be37f81 100644 --- a/markdown.html.markdown +++ b/markdown.html.markdown @@ -21,6 +21,13 @@ specific to a certain parser. - [Headings](#headings) - [Simple Text Styles](#simple-text-styles) +- [Paragraphs](#paragraphs) +- [Lists](#lists) +- [Code blocks](#code-blocks) +- [Horizontal rule](#horizontal-rule) +- [Links](#links) +- [Images](#images) +- [Miscellany](#miscellany) ## Headings @@ -198,9 +205,9 @@ end The above text doesn't require indenting, plus Github will use syntax highlighting of the language you specify after the \`\`\` -## Horizontal rule (`
`) +## Horizontal rule -Horizontal rules are easily added with three or more asterisks or hyphens, +Horizontal rules (`
`) are easily added with three or more asterisks or hyphens, with or without spaces. ```markdown *** -- cgit v1.2.3 From c32a8b2ca157c1be2d3fa67fe429a5e2e92241b6 Mon Sep 17 00:00:00 2001 From: Jacob Ward Date: Sun, 1 Nov 2015 19:38:55 -0700 Subject: Removed extraneous characters. --- markdown.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'markdown.html.markdown') diff --git a/markdown.html.markdown b/markdown.html.markdown index 7be37f81..e148213c 100644 --- a/markdown.html.markdown +++ b/markdown.html.markdown @@ -242,7 +242,7 @@ Markdown also supports reference style links. ``` The title can also be in single quotes or in parentheses, or omitted entirely. The references can be anywhere in your document and the reference IDs -can be anything so long as they are unique. --> +can be anything so long as they are unique. There is also "implicit naming" which lets you use the link text as the id. ```markdown -- cgit v1.2.3 From 9444609b7d44a7f16cbd6c920374eb5e26f10725 Mon Sep 17 00:00:00 2001 From: Jacob Ward Date: Sun, 1 Nov 2015 20:32:41 -0700 Subject: Fixed grammar --- markdown.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'markdown.html.markdown') diff --git a/markdown.html.markdown b/markdown.html.markdown index e148213c..d38bfe33 100644 --- a/markdown.html.markdown +++ b/markdown.html.markdown @@ -9,7 +9,7 @@ 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). -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. This 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 -- cgit v1.2.3 From c64f9231a9e9eb797519a582a73dbca452f00672 Mon Sep 17 00:00:00 2001 From: Jacob Ward Date: Sun, 1 Nov 2015 20:56:59 -0700 Subject: fix kbd tag --- markdown.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'markdown.html.markdown') diff --git a/markdown.html.markdown b/markdown.html.markdown index d38bfe33..64f5f351 100644 --- a/markdown.html.markdown +++ b/markdown.html.markdown @@ -284,7 +284,7 @@ in italics, so I do this: \*this text surrounded by asterisks\*. ### Keyboard keys -In Github Flavored Markdown, you can use a tag to represent keyboard keys. +In Github Flavored Markdown, you can use a `` tag to represent keyboard keys. ```markdown Your computer crashed? Try sending a Ctrl+Alt+Del -- cgit v1.2.3 From db4e212602121c5d84fc987d47054dbbbe21b1b0 Mon Sep 17 00:00:00 2001 From: Jacob Ward Date: Mon, 2 Nov 2015 08:11:50 -0700 Subject: Demonstrate html comments --- markdown.html.markdown | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'markdown.html.markdown') diff --git a/markdown.html.markdown b/markdown.html.markdown index 64f5f351..5f8d31c8 100644 --- a/markdown.html.markdown +++ b/markdown.html.markdown @@ -19,6 +19,7 @@ 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. +- [HTML Elements](#html-elements) - [Headings](#headings) - [Simple Text Styles](#simple-text-styles) - [Paragraphs](#paragraphs) @@ -29,6 +30,12 @@ specific to a certain parser. - [Images](#images) - [Miscellany](#miscellany) +## HTML Elements +Markdown is a superset of HTML, so any HTML file is valid Markdown. +```markdown + +``` + ## Headings You can create HTML elements `

` through `

` easily by prepending the -- cgit v1.2.3 From 6d705f17b6295be0525ff98a94dd4703912e3654 Mon Sep 17 00:00:00 2001 From: Jacob Ward Date: Mon, 2 Nov 2015 08:17:40 -0700 Subject: fix demonstrate html elements/comments --- markdown.html.markdown | 6 ------ 1 file changed, 6 deletions(-) (limited to 'markdown.html.markdown') diff --git a/markdown.html.markdown b/markdown.html.markdown index 5f8d31c8..fdc59067 100644 --- a/markdown.html.markdown +++ b/markdown.html.markdown @@ -9,12 +9,6 @@ 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). -Markdown is a superset of HTML, so any HTML file is valid Markdown. This -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. - 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. -- cgit v1.2.3 From 2469dd6f445bee0758c621a99e24fea8adc97c59 Mon Sep 17 00:00:00 2001 From: Jacob Ward Date: Mon, 2 Nov 2015 08:29:25 -0700 Subject: fix line breaks --- markdown.html.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'markdown.html.markdown') diff --git a/markdown.html.markdown b/markdown.html.markdown index fdc59067..8961c995 100644 --- a/markdown.html.markdown +++ b/markdown.html.markdown @@ -27,7 +27,9 @@ specific to a certain parser. ## HTML Elements Markdown is a superset of HTML, so any HTML file is valid Markdown. ```markdown - + ``` ## Headings -- cgit v1.2.3