Public-Mirrors
/
markdown-it
mirror of https://github.com/markdown-it/markdown-it.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

Demo update

pull/14/head
Vitaly Puzrin 10 years ago
parent
b27c630815
commit
e52196d10e
6 changed files with 2463 additions and 1082 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 10
      demo/assets/index.js
  2. 538
      demo/index.html
  3. 14
      demo/index.jade
  4. 503
      demo/sample.md
  5. 2475
      dist/remarkable.js
  6. 5
      dist/remarkable.min.js

10
demo/assets/index.js
View File

@ -4,10 +4,12 @@
var mdHtml, mdSrc, permalink; var mdHtml, mdSrc, permalink;
var defaults = { var defaults = {
html: true, html: true, // Enable html tags in source
xhtmlOut: true, xhtmlOut: true, // Use '/' to close single tags (<br />)
breaks: false, breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', langPrefix: 'language-', // CSS language prefix for fenced blocks
linkify: false, // autoconvert url-like texts to links
typographer: false, // Enable smartypants and other sweet transforms
// options below are for demo only // options below are for demo only
_highlight: false, _highlight: false,

538
demo/index.html
View File

@ -17,15 +17,18 @@
<h1>Remarkable demo</h1> <h1>Remarkable demo</h1>
<p><a data-toggle="collapse" href="#code-sample">code sample</a></p> <p><a data-toggle="collapse" href="#code-sample">code sample</a></p>
<pre id="code-sample" class="collapse code-sample"><code class="js">var Remarkable = require('remarkable'); <pre id="code-sample" class="collapse code-sample"><code class="js">var Remarkable = require('remarkable');
var md = new Remarkable({ var md = new Remarkable({
html: false, // enable html tags in source html: false, // Enable html tags in source
xhtml: false, // use '/' to close single tags (&lt;br /&gt;) xhtmlOut: false, // Use '/' to close single tags (&lt;br /&gt;)
breaks: true, // convert '\n' in paragraphs into &lt;br&gt; breaks: false, // Convert '\n' in paragraphs into &lt;br&gt;
langPrefix: 'language-', // css language prefix for fenced blocks langPrefix: 'language-', // CSS language prefix for fenced blocks
linkify: false, // autoconvert url-like texts to links
// Should return HTML markup for highlighted text, typographer: false, // Enable smartypants and other sweet transforms
// or empty string to escape source
highlight: function (str, lang) { return ''; } // Highlighter function. Should return escaped html,
// or '' if input not changed
highlight: function (/*str, , lang*/) { return ''; }
}); });
console.log(md.parse('# Remarkable rulezz!')); console.log(md.parse('# Remarkable rulezz!'));
@ -38,8 +41,8 @@ console.log(md.parse('# Remarkable rulezz!'));
</label> </label>
</div> </div>
<div class="checkbox"> <div class="checkbox">
<label title="add / to single tags (&lt;br /&gt; instead of &lt;br&gt;" class="_tip"> <label title="produce xtml output (add / to single tags (&lt;br /&gt; instead of &lt;br&gt;)" class="_tip">
<input id="xhtml" type="checkbox"> xhtml <input id="xhtmlOut" type="checkbox"> xhtmlOut
</label> </label>
</div> </div>
<div class="checkbox"> <div class="checkbox">
@ -47,6 +50,16 @@ console.log(md.parse('# Remarkable rulezz!'));
<input id="breaks" type="checkbox"> breaks <input id="breaks" type="checkbox"> breaks
</label> </label>
</div> </div>
<div class="checkbox">
<label title="autoconvert link-like texts to links" class="_tip">
<input id="linkify" type="checkbox"> linkify
</label>
</div>
<div class="checkbox">
<label title="do typographyc replacements, (c) -&gt; © and so on" class="_tip">
<input id="typographer" type="checkbox"> typographer
</label>
</div>
<div class="checkbox"> <div class="checkbox">
<label title="enable output highlight for fenced blocks" class="_tip"> <label title="enable output highlight for fenced blocks" class="_tip">
<input id="_highlight" type="checkbox"> highlight <input id="_highlight" type="checkbox"> highlight
@ -61,56 +74,16 @@ console.log(md.parse('# Remarkable rulezz!'));
<div class="row full-height"> <div class="row full-height">
<div class="col-xs-6 full-height"> <div class="col-xs-6 full-height">
<div class="demo-control"><a href="#" class="source-clear">clear</a><a id="permalink" href="./" title="Share this snippet as link"><strong>permalink</strong></a></div> <div class="demo-control"><a href="#" class="source-clear">clear</a><a id="permalink" href="./" title="Share this snippet as link"><strong>permalink</strong></a></div>
<textarea class="source full-height"># Typography <textarea class="source full-height"># h1 Heading
## Headings
Headings from `h1` through `h6` are constructed with a `#` for each level:
``` markdown
# h1 Heading
## h2 Heading ## h2 Heading
### h3 Heading ### h3 Heading
#### h4 Heading #### h4 Heading
##### h5 Heading ##### h5 Heading
###### h6 Heading ###### h6 Heading
```
Renders to:
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
HTML:
``` html
&lt;h1&gt;h1 Heading&lt;/h1&gt;
&lt;h2&gt;h2 Heading&lt;/h2&gt;
&lt;h3&gt;h3 Heading&lt;/h3&gt;
&lt;h4&gt;h4 Heading&lt;/h4&gt;
&lt;h5&gt;h5 Heading&lt;/h5&gt;
&lt;h6&gt;h6 Heading&lt;/h6&gt;
```
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;
## Horizontal Rules ## Horizontal Rules
The HTML `&lt;hr&gt;` element is for creating a &quot;thematic break&quot; between paragraph-level elements. In markdown, you can create a `&lt;hr&gt;` with any of the following:
* `___`: three consecutive underscores
* `---`: three consecutive dashes
* `***`: three consecutive asterisks
renders to:
___ ___
--- ---
@ -118,165 +91,49 @@ ___
*** ***
&lt;br&gt; ## Typographic replacements
&lt;br&gt;
&lt;br&gt;
## Body Copy
Body copy written as normal, plain text will be wrapped with `&lt;p&gt;&lt;/p&gt;` tags in the rendered HTML. Enable typographer option to see result.
So this body copy: (c) (C) (r) (R) (tm) (TM) (p) (P) +-
``` markdown test.. test... test..... test?..... test!....
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
```
renders to this HTML:
``` html
&lt;p&gt;Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.&lt;/p&gt;
```
!!!!!! ???? ,,
&lt;br&gt; Remarkable -- awesome
&lt;br&gt;
&lt;br&gt;
## Emphasis ## Emphasis
### Bold **This is bold text**
For emphasizing a snippet of text with a heavier font-weight.
The following snippet of text is **rendered as bold text**.
``` markdown
**rendered as bold text**
```
renders to:
**rendered as bold text**
and this HTML
``` html
&lt;strong&gt;rendered as bold text&lt;/strong&gt;
```
### Italics
For emphasizing a snippet of text with italics.
The following snippet of text is _rendered as italicized text_.
``` markdown
_rendered as italicized text_
```
renders to: __This is bold text__
_rendered as italicized text_ *This is italic text*
and this HTML: _This is italic text_
``` html
&lt;em&gt;rendered as italicized text&lt;/em&gt;
```
### strikethrough
In GFM you can do strickthroughs.
``` markdown
~~Strike through this text.~~
```
Which renders to:
~~Strike through this text.~~ ~~Strike through this text.~~
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;
## Blockquotes ## Blockquotes
For quoting blocks of content from another source within your document.
Add `&gt;` before any text you want to quote.
``` markdown
Add `&gt;` before any text you want to quote.
```
Renders to:
&gt; Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante. &gt; Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
and this HTML:
``` html
&lt;blockquote&gt;
&lt;p&gt;Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.&lt;/p&gt;
&lt;/blockquote&gt;
```
Blockquotes can also be nested: Blockquotes can also be nested:
``` markdown &gt; Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
&gt; Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. &gt;&gt; Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
&gt;&gt; Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
&gt;&gt;&gt; Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
```
Renders to:
&gt; Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
&gt;&gt; Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
&gt;&gt;&gt; Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. &gt;&gt;&gt; Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;
## Lists ## Lists
### Unordered Unordered
A list of items in which the order of the items does not explicitly matter.
You may use any of the following symbols to denote bullets for each list item:
```markdown
* valid bullet
- valid bullet
+ valid bullet
```
For example
``` markdown
+ Lorem ipsum dolor sit amet
+ Consectetur adipiscing elit
+ Integer molestie lorem at massa
+ Facilisis in pretium nisl aliquet
+ Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
+ Faucibus porta lacus fringilla vel
+ Aenean sit amet erat nunc
+ Eget porttitor lorem
```
Renders to:
+ Lorem ipsum dolor sit amet + Lorem ipsum dolor sit amet
+ Consectetur adipiscing elit + Consectetur adipiscing elit
@ -287,47 +144,13 @@ Renders to:
- Purus sodales ultricies - Purus sodales ultricies
- Vestibulum laoreet porttitor sem - Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at - Ac tristique libero volutpat at
* Consectetur adipiscing elit
* Integer molestie lorem at massa
+ Faucibus porta lacus fringilla vel + Faucibus porta lacus fringilla vel
+ Aenean sit amet erat nunc + Aenean sit amet erat nunc
+ Eget porttitor lorem + Eget porttitor lorem
And this HTML Ordered
``` html
&lt;ul&gt;
&lt;li&gt;Lorem ipsum dolor sit amet&lt;/li&gt;
&lt;li&gt;Consectetur adipiscing elit&lt;/li&gt;
&lt;li&gt;Integer molestie lorem at massa&lt;/li&gt;
&lt;li&gt;Facilisis in pretium nisl aliquet&lt;/li&gt;
&lt;li&gt;Nulla volutpat aliquam velit
&lt;ul&gt;
&lt;li&gt;Phasellus iaculis neque&lt;/li&gt;
&lt;li&gt;Purus sodales ultricies&lt;/li&gt;
&lt;li&gt;Vestibulum laoreet porttitor sem&lt;/li&gt;
&lt;li&gt;Ac tristique libero volutpat at&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;Faucibus porta lacus fringilla vel&lt;/li&gt;
&lt;li&gt;Aenean sit amet erat nunc&lt;/li&gt;
&lt;li&gt;Eget porttitor lorem&lt;/li&gt;
&lt;/ul&gt;
```
### Ordered
A list of items in which the order of items does explicitly matter.
``` markdown
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
4. Facilisis in pretium nisl aliquet
5. Nulla volutpat aliquam velit
6. Faucibus porta lacus fringilla vel
7. Aenean sit amet erat nunc
8. Eget porttitor lorem
```
Renders to:
1. Lorem ipsum dolor sit amet 1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit 2. Consectetur adipiscing elit
@ -338,133 +161,28 @@ Renders to:
7. Aenean sit amet erat nunc 7. Aenean sit amet erat nunc
8. Eget porttitor lorem 8. Eget porttitor lorem
And this HTML:
``` html
&lt;ol&gt;
&lt;li&gt;Lorem ipsum dolor sit amet&lt;/li&gt;
&lt;li&gt;Consectetur adipiscing elit&lt;/li&gt;
&lt;li&gt;Integer molestie lorem at massa&lt;/li&gt;
&lt;li&gt;Facilisis in pretium nisl aliquet&lt;/li&gt;
&lt;li&gt;Nulla volutpat aliquam velit&lt;/li&gt;
&lt;li&gt;Faucibus porta lacus fringilla vel&lt;/li&gt;
&lt;li&gt;Aenean sit amet erat nunc&lt;/li&gt;
&lt;li&gt;Eget porttitor lorem&lt;/li&gt;
&lt;/ol&gt;
```
**TIP**: If you just use `1.` for each number, GitHub will automatically number each item. For example:
``` markdown
1. Lorem ipsum dolor sit amet
1. Consectetur adipiscing elit
1. Integer molestie lorem at massa
1. Facilisis in pretium nisl aliquet
1. Nulla volutpat aliquam velit
1. Faucibus porta lacus fringilla vel
1. Aenean sit amet erat nunc
1. Eget porttitor lorem
```
Renders to:
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
4. Facilisis in pretium nisl aliquet
5. Nulla volutpat aliquam velit
6. Faucibus porta lacus fringilla vel
7. Aenean sit amet erat nunc
8. Eget porttitor lorem
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;
## Code ## Code
### Inline code Inline `code`
Wrap inline snippets of code with `` ` ``.
For example, `&lt;section&gt;&lt;/section&gt;` should be wrapped as &quot;inline&quot;.
``` html
For example, `&lt;section&gt;&lt;/section&gt;` should be wrapped as &quot;inline&quot;.
```
### Indented code
Or indent several lines of code by at least four spaces, as in: Indented code
``` js
// Some comments // Some comments
line 1 of code line 1 of code
line 2 of code line 2 of code
line 3 of code line 3 of code
```
// Some comments
line 1 of code
line 2 of code
line 3 of code
### Block code &quot;fences&quot;
Use &quot;fences&quot; ```` ``` ```` to block in multiple lines of code.
&lt;pre&gt;
``` html
Sample text here...
```
&lt;/pre&gt;
Block code &quot;fences&quot;
``` ```
Sample text here... Sample text here...
``` ```
HTML: Syntax highlighting
``` html
&lt;pre&gt;
&lt;p&gt;Sample text here...&lt;/p&gt;
&lt;/pre&gt;
```
### Syntax highlighting
GFM, or &quot;GitHub Flavored Markdown&quot; also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code &quot;fence&quot;, ` ``` js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
&lt;pre&gt;
``` javascript
grunt.initConfig({
assemble: {
options: {
assets: 'docs/assets',
data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}']
},
pages: {
options: {
layout: 'default.hbs'
},
files: {
'./': ['src/templates/pages/index.hbs']
}
}
}
};
```
&lt;/pre&gt;
Renders to:
``` javascript ``` js
grunt.initConfig({ grunt.initConfig({
assemble: { assemble: {
options: { options: {
@ -485,91 +203,15 @@ grunt.initConfig({
}; };
``` ```
And this complicated HTML:
``` xml
&lt;div class=&quot;highlight&quot;&gt;&lt;pre&gt;&lt;span class=&quot;nx&quot;&gt;grunt&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;.&lt;/span&gt;&lt;span class=&quot;nx&quot;&gt;initConfig&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;({&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;assemble&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;{&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;options&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;{&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;assets&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;s1&quot;&gt;'docs/assets'&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;data&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;s1&quot;&gt;'src/data/*.{json,yml}'&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;helpers&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;s1&quot;&gt;'src/custom-helpers.js'&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;,&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;partials&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;[&lt;/span&gt;&lt;span class=&quot;s1&quot;&gt;'src/partials/**/*.{hbs,md}'&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;]&lt;/span&gt;
&lt;span class=&quot;p&quot;&gt;},&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;pages&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;{&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;options&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;{&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;layout&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;s1&quot;&gt;'default.hbs'&lt;/span&gt;
&lt;span class=&quot;p&quot;&gt;},&lt;/span&gt;
&lt;span class=&quot;nx&quot;&gt;files&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;{&lt;/span&gt;
&lt;span class=&quot;s1&quot;&gt;'./'&lt;/span&gt;&lt;span class=&quot;o&quot;&gt;:&lt;/span&gt; &lt;span class=&quot;p&quot;&gt;[&lt;/span&gt;&lt;span class=&quot;s1&quot;&gt;'src/templates/pages/index.hbs'&lt;/span&gt;&lt;span class=&quot;p&quot;&gt;]&lt;/span&gt;
&lt;span class=&quot;p&quot;&gt;}&lt;/span&gt;
&lt;span class=&quot;p&quot;&gt;}&lt;/span&gt;
&lt;span class=&quot;p&quot;&gt;}&lt;/span&gt;
&lt;span class=&quot;p&quot;&gt;};&lt;/span&gt;
&lt;/pre&gt;&lt;/div&gt;
```
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;
## Tables ## Tables
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
``` markdown
| Option | Description | | Option | Description |
| ------ | ----------- | | ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. | | 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. | | engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. | | ext | extension to be used for dest files. |
```
Renders to:
| 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. |
And this HTML:
``` html
&lt;table&gt;
&lt;tr&gt;
&lt;th&gt;Option&lt;/th&gt;
&lt;th&gt;Description&lt;/th&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;data&lt;/td&gt;
&lt;td&gt;path to data files to supply the data that will be passed into templates.&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;engine&lt;/td&gt;
&lt;td&gt;engine to be used for processing templates. Handlebars is the default.&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;ext&lt;/td&gt;
&lt;td&gt;extension to be used for dest files.&lt;/td&gt;
&lt;/tr&gt;
&lt;/table&gt;
```
### Right aligned text
Adding a colon on the right side of the dashes below any heading will right align text for that column. Right aligned columns
``` markdown
| 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. |
```
| Option | Description | | Option | Description |
| ------:| -----------:| | ------:| -----------:|
@ -578,104 +220,28 @@ Adding a colon on the right side of the dashes below any heading will right alig
| ext | extension to be used for dest files. | | ext | extension to be used for dest files. |
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;
## Links ## Links
### Basic link [link text](http://dev.nodeca.com)
``` markdown [link with title](http://nodeca.github.io/pica/demo/ &quot;title text!&quot;)
[Assemble](http://assemble.io)
```
Renders to (hover over the link, there is no tooltip): Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
[Assemble](http://assemble.io)
HTML:
``` html
&lt;a href=&quot;http://assemble.io&quot;&gt;Assemble&lt;/a&gt;
```
### Add a title
``` markdown
[Upstage](https://github.com/upstage/ &quot;Visit Upstage!&quot;)
```
Renders to (hover over the link, there should be a tooltip):
[Upstage](https://github.com/upstage/ &quot;Visit Upstage!&quot;)
HTML:
``` html
&lt;a href=&quot;https://github.com/upstage/&quot; title=&quot;Visit Upstage!&quot;&gt;Upstage&lt;/a&gt;
```
### Named Anchors
Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
```markdown
# Table of Contents
* [Chapter 1](#chapter-1)
* [Chapter 2](#chapter-2)
* [Chapter 3](#chapter-3)
```
will jump to these sections:
```markdown
## Chapter 1 &lt;a id=&quot;chapter-1&quot;&gt;&lt;/a&gt;
Content for chapter one.
## Chapter 2 &lt;a id=&quot;chapter-2&quot;&gt;&lt;/a&gt;
Content for chapter one.
## Chapter 3 &lt;a id=&quot;chapter-3&quot;&gt;&lt;/a&gt;
Content for chapter one.
```
**NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.
&lt;br&gt;
&lt;br&gt;
&lt;br&gt;
## Images ## Images
Images have a similar syntax to links but include a preceding exclamation point.
``` markdown
![Minion](http://octodex.github.com/images/minion.png)
```
![Minion](http://octodex.github.com/images/minion.png) ![Minion](http://octodex.github.com/images/minion.png)
or
``` markdown
![Alt text](http://octodex.github.com/images/stormtroopocat.jpg &quot;The Stormtroopocat&quot;)
```
![Alt text](http://octodex.github.com/images/stormtroopocat.jpg &quot;The Stormtroopocat&quot;) ![Alt text](http://octodex.github.com/images/stormtroopocat.jpg &quot;The Stormtroopocat&quot;)
Like links, Images also have a footnote style syntax Like links, Images also have a footnote style syntax
``` markdown
![Alt text][id]
```
![Alt text][id] ![Alt text][id]
With a reference later in the document defining the URL location: With a reference later in the document defining the URL location:
[id]: http://octodex.github.com/images/dojocat.jpg &quot;The Dojocat&quot; [id]: http://octodex.github.com/images/dojocat.jpg &quot;The Dojocat&quot;
[id]: http://octodex.github.com/images/dojocat.jpg &quot;The Dojocat&quot;
</textarea> </textarea>
</div> </div>
<section class="col-xs-6 full-height"> <section class="col-xs-6 full-height">

14
demo/index.jade
View File

@ -33,13 +33,21 @@ html
input#html(type='checkbox') input#html(type='checkbox')
| html | html
.checkbox .checkbox
label._tip(title='add / to single tags (<br /> instead of <br>') label._tip(title='produce xtml output (add / to single tags (<br /> instead of <br>)')
input#xhtml(type='checkbox') input#xhtmlOut(type='checkbox')
| xhtml | xhtmlOut
.checkbox .checkbox
label._tip(title='newlines in paragraphs are rendered as <br>') label._tip(title='newlines in paragraphs are rendered as <br>')
input#breaks(type='checkbox') input#breaks(type='checkbox')
| breaks | breaks
.checkbox
label._tip(title='autoconvert link-like texts to links')
input#linkify(type='checkbox')
| linkify
.checkbox
label._tip(title='do typographyc replacements, (c) -> © and so on')
input#typographer(type='checkbox')
| typographer
.checkbox .checkbox
label._tip(title='enable output highlight for fenced blocks') label._tip(title='enable output highlight for fenced blocks')
input#_highlight(type='checkbox') input#_highlight(type='checkbox')

503
demo/sample.md
View File

@ -1,20 +1,3 @@
# Typography
## Headings
Headings from `h1` through `h6` are constructed with a `#` for each level:
``` markdown
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
```
Renders to:
# h1 Heading # h1 Heading
## h2 Heading ## h2 Heading
### h3 Heading ### h3 Heading
@ -22,32 +5,9 @@ Renders to:
##### h5 Heading ##### h5 Heading
###### h6 Heading ###### h6 Heading
HTML:
``` html
<h1>h1 Heading</h1>
<h2>h2 Heading</h2>
<h3>h3 Heading</h3>
<h4>h4 Heading</h4>
<h5>h5 Heading</h5>
<h6>h6 Heading</h6>
```
<br>
<br>
<br>
## Horizontal Rules ## Horizontal Rules
The HTML `<hr>` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `<hr>` with any of the following:
* `___`: three consecutive underscores
* `---`: three consecutive dashes
* `***`: three consecutive asterisks
renders to:
___ ___
--- ---
@ -55,165 +15,49 @@ ___
*** ***
<br> ## Typographic replacements
<br>
<br>
Enable typographer option to see result.
## Body Copy (c) (C) (r) (R) (tm) (TM) (p) (P) +-
Body copy written as normal, plain text will be wrapped with `<p></p>` tags in the rendered HTML. test.. test... test..... test?..... test!....
So this body copy: !!!!!! ???? ,,
``` markdown Remarkable -- awesome
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
```
renders to this HTML:
``` html
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
```
<br>
<br>
<br>
## Emphasis ## Emphasis
### Bold **This is bold text**
For emphasizing a snippet of text with a heavier font-weight.
The following snippet of text is **rendered as bold text**. __This is bold text__
``` markdown *This is italic text*
**rendered as bold text**
```
renders to:
**rendered as bold text**
and this HTML _This is italic text_
``` html
<strong>rendered as bold text</strong>
```
### Italics
For emphasizing a snippet of text with italics.
The following snippet of text is _rendered as italicized text_.
``` markdown
_rendered as italicized text_
```
renders to:
_rendered as italicized text_
and this HTML:
``` html
<em>rendered as italicized text</em>
```
### strikethrough
In GFM you can do strickthroughs.
``` markdown
~~Strike through this text.~~
```
Which renders to:
~~Strike through this text.~~ ~~Strike through this text.~~
<br>
<br>
<br>
## Blockquotes ## Blockquotes
For quoting blocks of content from another source within your document.
Add `>` before any text you want to quote.
``` markdown
Add `>` before any text you want to quote.
```
Renders to:
> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante. > Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
and this HTML:
``` html
<blockquote>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
</blockquote>
```
Blockquotes can also be nested: Blockquotes can also be nested:
``` markdown > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. >> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
>>> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. >>> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
```
Renders to:
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
>> Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
>>> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
<br>
<br>
<br>
## Lists ## Lists
### Unordered Unordered
A list of items in which the order of the items does not explicitly matter.
You may use any of the following symbols to denote bullets for each list item:
```markdown
* valid bullet
- valid bullet
+ valid bullet
```
For example
``` markdown
+ Lorem ipsum dolor sit amet
+ Consectetur adipiscing elit
+ Integer molestie lorem at massa
+ Facilisis in pretium nisl aliquet
+ Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
+ Faucibus porta lacus fringilla vel
+ Aenean sit amet erat nunc
+ Eget porttitor lorem
```
Renders to:
+ Lorem ipsum dolor sit amet + Lorem ipsum dolor sit amet
+ Consectetur adipiscing elit + Consectetur adipiscing elit
@ -224,86 +68,13 @@ Renders to:
- Purus sodales ultricies - Purus sodales ultricies
- Vestibulum laoreet porttitor sem - Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at - Ac tristique libero volutpat at
* Consectetur adipiscing elit
* Integer molestie lorem at massa
+ Faucibus porta lacus fringilla vel + Faucibus porta lacus fringilla vel
+ Aenean sit amet erat nunc + Aenean sit amet erat nunc
+ Eget porttitor lorem + Eget porttitor lorem
And this HTML Ordered
``` html
<ul>
<li>Lorem ipsum dolor sit amet</li>
<li>Consectetur adipiscing elit</li>
<li>Integer molestie lorem at massa</li>
<li>Facilisis in pretium nisl aliquet</li>
<li>Nulla volutpat aliquam velit
<ul>
<li>Phasellus iaculis neque</li>
<li>Purus sodales ultricies</li>
<li>Vestibulum laoreet porttitor sem</li>
<li>Ac tristique libero volutpat at</li>
</ul>
</li>
<li>Faucibus porta lacus fringilla vel</li>
<li>Aenean sit amet erat nunc</li>
<li>Eget porttitor lorem</li>
</ul>
```
### Ordered
A list of items in which the order of items does explicitly matter.
``` markdown
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
4. Facilisis in pretium nisl aliquet
5. Nulla volutpat aliquam velit
6. Faucibus porta lacus fringilla vel
7. Aenean sit amet erat nunc
8. Eget porttitor lorem
```
Renders to:
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
4. Facilisis in pretium nisl aliquet
5. Nulla volutpat aliquam velit
6. Faucibus porta lacus fringilla vel
7. Aenean sit amet erat nunc
8. Eget porttitor lorem
And this HTML:
``` html
<ol>
<li>Lorem ipsum dolor sit amet</li>
<li>Consectetur adipiscing elit</li>
<li>Integer molestie lorem at massa</li>
<li>Facilisis in pretium nisl aliquet</li>
<li>Nulla volutpat aliquam velit</li>
<li>Faucibus porta lacus fringilla vel</li>
<li>Aenean sit amet erat nunc</li>
<li>Eget porttitor lorem</li>
</ol>
```
**TIP**: If you just use `1.` for each number, GitHub will automatically number each item. For example:
``` markdown
1. Lorem ipsum dolor sit amet
1. Consectetur adipiscing elit
1. Integer molestie lorem at massa
1. Facilisis in pretium nisl aliquet
1. Nulla volutpat aliquam velit
1. Faucibus porta lacus fringilla vel
1. Aenean sit amet erat nunc
1. Eget porttitor lorem
```
Renders to:
1. Lorem ipsum dolor sit amet 1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit 2. Consectetur adipiscing elit
@ -315,33 +86,11 @@ Renders to:
8. Eget porttitor lorem 8. Eget porttitor lorem
<br>
<br>
<br>
## Code ## Code
### Inline code Inline `code`
Wrap inline snippets of code with `` ` ``.
For example, `<section></section>` should be wrapped as "inline".
``` html
For example, `<section></section>` should be wrapped as "inline".
```
### Indented code
Or indent several lines of code by at least four spaces, as in:
``` js Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
```
// Some comments // Some comments
line 1 of code line 1 of code
@ -349,59 +98,15 @@ Or indent several lines of code by at least four spaces, as in:
line 3 of code line 3 of code
### Block code "fences" Block code "fences"
Use "fences" ```` ``` ```` to block in multiple lines of code.
<pre>
``` html
Sample text here...
```
</pre>
``` ```
Sample text here... Sample text here...
``` ```
HTML: Syntax highlighting
``` html
<pre>
<p>Sample text here...</p>
</pre>
```
### Syntax highlighting
GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ``` js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
<pre>
``` javascript
grunt.initConfig({
assemble: {
options: {
assets: 'docs/assets',
data: 'src/data/*.{json,yml}',
helpers: 'src/custom-helpers.js',
partials: ['src/partials/**/*.{hbs,md}']
},
pages: {
options: {
layout: 'default.hbs'
},
files: {
'./': ['src/templates/pages/index.hbs']
}
}
}
};
```
</pre>
Renders to:
``` javascript ``` js
grunt.initConfig({ grunt.initConfig({
assemble: { assemble: {
options: { options: {
@ -422,50 +127,7 @@ grunt.initConfig({
}; };
``` ```
And this complicated HTML:
``` xml
<div class="highlight"><pre><span class="nx">grunt</span><span class="p">.</span><span class="nx">initConfig</span><span class="p">({</span>
<span class="nx">assemble</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">options</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">assets</span><span class="o">:</span> <span class="s1">'docs/assets'</span><span class="p">,</span>
<span class="nx">data</span><span class="o">:</span> <span class="s1">'src/data/*.{json,yml}'</span><span class="p">,</span>
<span class="nx">helpers</span><span class="o">:</span> <span class="s1">'src/custom-helpers.js'</span><span class="p">,</span>
<span class="nx">partials</span><span class="o">:</span> <span class="p">[</span><span class="s1">'src/partials/**/*.{hbs,md}'</span><span class="p">]</span>
<span class="p">},</span>
<span class="nx">pages</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">options</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">layout</span><span class="o">:</span> <span class="s1">'default.hbs'</span>
<span class="p">},</span>
<span class="nx">files</span><span class="o">:</span> <span class="p">{</span>
<span class="s1">'./'</span><span class="o">:</span> <span class="p">[</span><span class="s1">'src/templates/pages/index.hbs'</span><span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">};</span>
</pre></div>
```
<br>
<br>
<br>
## Tables ## Tables
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
``` markdown
| 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. |
```
Renders to:
| Option | Description | | Option | Description |
| ------ | ----------- | | ------ | ----------- |
@ -473,40 +135,7 @@ Renders to:
| engine | engine to be used for processing templates. Handlebars is the default. | | engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. | | ext | extension to be used for dest files. |
And this HTML: Right aligned columns
``` html
<table>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
<tr>
<td>data</td>
<td>path to data files to supply the data that will be passed into templates.</td>
</tr>
<tr>
<td>engine</td>
<td>engine to be used for processing templates. Handlebars is the default.</td>
</tr>
<tr>
<td>ext</td>
<td>extension to be used for dest files.</td>
</tr>
</table>
```
### Right aligned text
Adding a colon on the right side of the dashes below any heading will right align text for that column.
``` markdown
| 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. |
```
| Option | Description | | Option | Description |
| ------:| -----------:| | ------:| -----------:|
@ -515,101 +144,25 @@ Adding a colon on the right side of the dashes below any heading will right alig
| ext | extension to be used for dest files. | | ext | extension to be used for dest files. |
<br>
<br>
<br>
## Links ## Links
### Basic link [link text](http://dev.nodeca.com)
``` markdown
[Assemble](http://assemble.io)
```
Renders to (hover over the link, there is no tooltip):
[Assemble](http://assemble.io)
HTML:
``` html
<a href="http://assemble.io">Assemble</a>
```
### Add a title
``` markdown
[Upstage](https://github.com/upstage/ "Visit Upstage!")
```
Renders to (hover over the link, there should be a tooltip):
[Upstage](https://github.com/upstage/ "Visit Upstage!")
HTML:
``` html
<a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
```
### Named Anchors
Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
```markdown
# Table of Contents
* [Chapter 1](#chapter-1)
* [Chapter 2](#chapter-2)
* [Chapter 3](#chapter-3)
```
will jump to these sections:
```markdown
## Chapter 1 <a id="chapter-1"></a>
Content for chapter one.
## Chapter 2 <a id="chapter-2"></a>
Content for chapter one.
## Chapter 3 <a id="chapter-3"></a>
Content for chapter one.
```
**NOTE** that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
<br> Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
<br>
<br>
## Images ## Images
Images have a similar syntax to links but include a preceding exclamation point.
``` markdown
![Minion](http://octodex.github.com/images/minion.png)
```
![Minion](http://octodex.github.com/images/minion.png) ![Minion](http://octodex.github.com/images/minion.png)
or
``` markdown
![Alt text](http://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
```
![Alt text](http://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") ![Alt text](http://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
Like links, Images also have a footnote style syntax Like links, Images also have a footnote style syntax
``` markdown
![Alt text][id]
```
![Alt text][id] ![Alt text][id]
With a reference later in the document defining the URL location: With a reference later in the document defining the URL location:
[id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat" [id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat"
[id]: http://octodex.github.com/images/dojocat.jpg "The Dojocat"

2475
dist/remarkable.js
View File

File diff suppressed because it is too large

5
dist/remarkable.min.js
View File

File diff suppressed because one or more lines are too long
Write Preview
Loading…
Cancel
Save