Marked lets you convert Markdown into HTML. Markdown is a simple text format whose goal is to be very easy to read and write, even when not converted to HTML. This demo page will let you type anything you like and see how it gets converted. Live. No more waiting around.
- Type in stuff on the left.
- See the live updates on the right.
That's it. Pretty simple. There's also a drop-down option in the upper right to switch between various views:
- Preview: A live display of the generated HTML as it would render in a browser.
- HTML Source: The generated HTML before your browser makes it pretty.
- Lexer Data: What marked uses internally, in case you like gory stuff like this.
- Quick Reference: A brief run-down of how to format things using markdown.
It's easy. It's not overly bloated, unlike HTML. Also, as the creator of markdown says,
The overriding design goal for Markdown's formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions.
marked.setOptions({
highlight: function(code, lang) {
if (typeof lang === 'undefined') {
return hljs.highlightAuto(code).value;
} else if (lang === 'nohighlight') {
return code;
} else {
return hljs.highlight(lang, code).value;
}
}
});
Ready to start writing? Either start changing stuff on the left or clear everything with a simple click.
## h2 Heading ### h3 HeadingEnable typographer option to see result.
(c) (C) (r) (R) (tm) (TM) (p) (P) +-
test.. test... test..... test?..... test!....
!!!!!! ???? ,, -- ---
"Smartypants, double quotes" and 'single quotes'
This is bold text
This is bold text
This is italic text
This is italic text
Strikethrough
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.
Unordered
- Create a list by starting a line with
+
,-
, or*
- Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
- Ac tristique libero volutpat at
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Marker character change forces new list start:
- Very easy!
Ordered
-
Lorem ipsum dolor sit amet
-
Consectetur adipiscing elit
-
Integer molestie lorem at massa
-
You can use sequential numbers...
-
...or keep all the numbers as
1.
Start numbering with offset:
- foo
- bar
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code "fences"
Sample text here...
Syntax highlighting
var foo = function (bar) {
return bar++;
};
console.log(foo(5));
package main
import "fmt"
func main() {
fmt.Println("Hello, world!")
}
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Right aligned columns
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Autoconverted link https://github.com/miaolz123/vue-markdown (enable linkify to see)
Like links, Images also have a footnote style syntax
With a reference later in the document defining the URL location:
Classic markup: 😉 😢 😆 😋
Shortcuts (emoticons): :-) :-( 8-) ;)
- 19^th^
- H
2O
++Inserted text++
==Marked text==
Footnote 1 link1.
Footnote 2 link2.
Inline footnote^[Text of inline footnote] definition.
Duplicated footnote reference2.
Term 1
: Definition 1 with lazy continuation.
Term 2 with inline markup
: Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
Compact style:
Term 1 ~ Definition 1
Term 2 ~ Definition 2a ~ Definition 2b
This is HTML abbreviation example.
It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
*[HTML]: Hyper Text Markup Language