From ab3cda9527798e1da5a090d40e72fca65e47c877 Mon Sep 17 00:00:00 2001 From: Vitaly Puzrin Date: Tue, 30 Sep 2014 16:41:45 +0400 Subject: [PATCH] Refactored demo build scripts --- .eslintignore | 1 + Makefile | 7 +- demo/assets/index.css | 29 +- demo/assets/index.styl | 67 +++++ demo/data.yml | 88 ------ demo/index.html | 585 +++++++++++++++++++++++++++++++++++++-- demo/sample.js | 11 + demo/sample.md | 615 +++++++++++++++++++++++++++++++++++++++++ package.json | 2 +- support/demodata.js | 17 ++ 10 files changed, 1293 insertions(+), 129 deletions(-) create mode 100644 demo/assets/index.styl delete mode 100644 demo/data.yml create mode 100644 demo/sample.js create mode 100644 demo/sample.md create mode 100755 support/demodata.js diff --git a/.eslintignore b/.eslintignore index 0262b4e..9cbd2af 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,3 +1,4 @@ benchmark/implementations/ +demo/sample.js dist/ node_modules/ diff --git a/Makefile b/Makefile index 12901d5..be503db 100644 --- a/Makefile +++ b/Makefile @@ -13,9 +13,10 @@ GITHUB_PROJ := https://github.com//jonschlinkert/${NPM_PACKAGE} demo: lint browserify - js-yaml demo/data.yml > demo/data.json - jade demo/index.jade -P --obj demo/data.json - rm -rf demo/data.json + ./support/demodata.js > demo/sample.json + jade demo/index.jade -P --obj demo/sample.json + stylus demo/assets/index.styl + rm -rf demo/sample.json lint: diff --git a/demo/assets/index.css b/demo/assets/index.css index c3dfac4..bb0b142 100644 --- a/demo/assets/index.css +++ b/demo/assets/index.css @@ -2,32 +2,33 @@ body { margin-bottom: 20px; overflow: hidden; } - -.source, .result, .result-src { +.source, +.result, +.result-src { width: 100%; height: 350px; } - .result { padding-right: 20px; overflow: auto; } - +.result img { + max-width: 100%; +} .result-src { display: none; } .result-src-content { white-space: pre; } - .result-as-text .result-src { display: block; } .result-as-text .result { display: none; } - -.result-mode, .source-clear { +.result-mode, +.source-clear { position: absolute; right: 15px; top: 0; @@ -38,12 +39,10 @@ body { background-color: #666; color: #fff !important; } - .hljs { background: none; - padding: 0 + padding: 0; } - .gh-ribbon { display: block; position: absolute; @@ -54,16 +53,14 @@ body { transform: rotate(45deg); width: 230px; z-index: 10000; - white-space: nowrap - font-family: "Helvetica Neue",Helvetica,Arial,sans-serif; + white-space: nowrap; + font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; background-color: #686868; - box-shadow: 0 0 2px rgba(102, 102, 102, 0.4); + box-shadow: 0 0 2px rgba(102,102,102,0.4); padding: 1px 0; } -.gh-ribbon a, .gh-ribbon a:hover { - text-decoration: none; -} .gh-ribbon a { + text-decoration: none !important; border: 1px solid #ccc; color: #fff; display: block; diff --git a/demo/assets/index.styl b/demo/assets/index.styl new file mode 100644 index 0000000..8b1d313 --- /dev/null +++ b/demo/assets/index.styl @@ -0,0 +1,67 @@ +body + margin-bottom 20px + overflow hidden + +.source, .result, .result-src + width 100% + height 350px + +.result + padding-right 20px + overflow auto + img + max-width 100% + +.result-src + display none + +.result-src-content + white-space pre + +.result-as-text + .result-src + display block + .result + display none + +.result-mode, .source-clear + position absolute + right 15px + top 0 + padding 0 10px + border-radius 0 4px + font-weight bold + font-size 12px + background-color #666 + color #fff !important + +.hljs + background none + padding 0 + +.gh-ribbon + display block + position absolute + right -60px + top 44px + -webkit-transform rotate(45deg) + -moz-transform rotate(45deg) + transform rotate(45deg) + width 230px + z-index 10000 + white-space nowrap + font-family "Helvetica Neue", Helvetica, Arial, sans-serif + background-color #686868 + box-shadow 0 0 2px rgba(102,102,102,0.4) + padding 1px 0 + + a + text-decoration none !important + border 1px solid #ccc + color #fff + display block + font-size 13px + font-weight 700 + outline medium none + padding 4px 50px 2px + text-align center diff --git a/demo/data.yml b/demo/data.yml deleted file mode 100644 index 48acf67..0000000 --- a/demo/data.yml +++ /dev/null @@ -1,88 +0,0 @@ - -self: - demo: - code: | - var Remarkable = require('remarkable'); - - var md = new Remarkable({ - html: true, - xhtml: true, - breaks: false, - langprefix: 'language-' - }); - - console.log(md.parse('# Remarkable rulezz!')); - // =>

Remarkable rulezz!

- source: | - # h1 Heading - ## h2 Heading - ### h3 Heading - #### h4 Heading - ##### h5 Heading - ###### h6 Heading - - Alt h1 Heading - ============== - - Alt h2 Heading - -------------- - - ## Horizontal Rules - - --- - - ___ - - - *** - - ## Text - - 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. - - ## Emphasis - - __bold text__ - - _italicized text_ - - ~~strike through text~~ - - ## Blockquotes - - > Quoted text - >> Quotes can be nested - - ## Lists - - Unordered: - - * valid bullet - - valid bullet - + valid bullet - - Phasellus iaculis neque - - Purus sodales ultricies - - Ordered: - - 1. Lorem ipsum dolor sit amet - 2. Consectetur adipiscing elit - 3. Integer molestie lorem at massa - - ## Code - - This is `example of inline code`. - - Code block (with language name for highlighter) - - ``` javascript - var text = 'Remarkable is awesome!'; - - console.log(text); - ``` - - ## links - - [Basic link](https://github.com/jonschlinkert/remarkable) - - [Link with title](https://github.com/jonschlinkert/remarkable "Awesome markdown parser") diff --git a/demo/index.html b/demo/index.html index 381246a..825a33c 100644 --- a/demo/index.html +++ b/demo/index.html @@ -28,78 +28,621 @@ console.log(md.parse('# Remarkable rulezz!'));
clear -
html / source diff --git a/demo/sample.js b/demo/sample.js new file mode 100644 index 0000000..406665f --- /dev/null +++ b/demo/sample.js @@ -0,0 +1,11 @@ +var Remarkable = require('remarkable'); + +var md = new Remarkable({ + html: true, + xhtml: true, + breaks: false, + langprefix: 'language-' +}); + +console.log(md.parse('# Remarkable rulezz!')); +// =>

Remarkable rulezz!

diff --git a/demo/sample.md b/demo/sample.md new file mode 100644 index 0000000..49a1cff --- /dev/null +++ b/demo/sample.md @@ -0,0 +1,615 @@ +# 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 +## h2 Heading +### h3 Heading +#### h4 Heading +##### h5 Heading +###### h6 Heading + +HTML: + +``` html +

h1 Heading

+

h2 Heading

+

h3 Heading

+

h4 Heading

+
h5 Heading
+
h6 Heading
+``` + +
+
+
+ + +## Horizontal Rules + +The HTML `
` element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a `
` with any of the following: + +* `___`: three consecutive underscores +* `---`: three consecutive dashes +* `***`: three consecutive asterisks + +renders to: + +___ + +--- + +*** + + +
+
+
+ + +## Body Copy + +Body copy written as normal, plain text will be wrapped with `

` tags in the rendered HTML. + +So this body copy: + +``` markdown +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 +

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.

+``` + + +
+
+
+ + +## Emphasis + +### Bold +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 +rendered as bold text +``` + +### 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 +rendered as italicized text +``` + + +### strikethrough +In GFM you can do strickthroughs. + +``` markdown +~~Strike through this text.~~ +``` +Which renders to: + +~~Strike through this text.~~ + + +
+
+
+ + +## 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. + +and this HTML: + +``` html +
+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

+
+``` + +Blockquotes can also be nested: + +``` markdown +> 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. +``` + +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. + + +
+
+
+ + +## Lists + +### 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 ++ 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 + +And this HTML + +``` html +
    +
  • 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
    • +
+``` + +### 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 +
    +
  1. Lorem ipsum dolor sit amet
    2. +
  2. Consectetur adipiscing elit
    3. +
  3. Integer molestie lorem at massa
    4. +
  4. Facilisis in pretium nisl aliquet
    5. +
  5. Nulla volutpat aliquam velit
    6. +
  6. Faucibus porta lacus fringilla vel
    7. +
  7. Aenean sit amet erat nunc
    8. +
  8. Eget porttitor lorem
    9. +
+``` + +**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 + + +
+
+
+ + +## Code + +### Inline code +Wrap inline snippets of code with `` ` ``. + +For example, `
` should be wrapped as "inline". + +``` html +For example, `
` should be wrapped as "inline". +``` + + +### Indented code + +Or indent several lines of code by at least four spaces, as in: + +``` js + // Some comments + line 1 of code + line 2 of code + line 3 of code +``` + + // Some comments + line 1 of code + line 2 of code + line 3 of code + + +### Block code "fences" + +Use "fences" ```` ``` ```` to block in multiple lines of code. + +
+``` html
+Sample text here...
+```
+
+ + +``` +Sample text here... +``` + +HTML: + +``` html +
+  
Sample text here...

+
+``` + +### 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: + +
+``` 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']
+      }
+    }
+  }
+};
+```
+
+ +Renders to: + +``` 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'] + } + } + } +}; +``` + +And this complicated HTML: + +``` xml +
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']
+      }
+    }
+  }
+};
+
+``` + + +
+
+
+ + + +## 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 | +| ------ | ----------- | +| 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 + + + + + + + + + + + + + + + + + +
OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.
+``` + +### 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 | +| ------:| -----------:| +| 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. | + + +
+
+
+ + +## Links + +### Basic link + +``` markdown +[Assemble](http://assemble.io) +``` + +Renders to (hover over the link, there is no tooltip): + +[Assemble](http://assemble.io) + +HTML: + +``` html +Assemble +``` + + +### 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 +Upstage +``` + +### 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 +Content for chapter one. + +## Chapter 2 +Content for chapter one. + +## Chapter 3 +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. + + +
+
+
+ + +## 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) + +or +``` markdown +![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 + +``` markdown +![Alt text][id] +``` +![Alt text][id] + +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" + diff --git a/package.json b/package.json index 9b947f2..1336581 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "eslint": "0.8.0", "eslint-plugin-nodeca": "^1.0.0", "jade": "1.6.0", - "js-yaml": "3.2.2", + "stylus": "0.49.1", "mocha": "*", "uglify-js": "*" } diff --git a/support/demodata.js b/support/demodata.js new file mode 100755 index 0000000..ff918b1 --- /dev/null +++ b/support/demodata.js @@ -0,0 +1,17 @@ +#!/usr/bin/env node + +// Build demo data for embedding into html + +/*eslint no-console:0*/ + +var fs = require('fs'); +var path = require('path'); + +console.log(JSON.stringify({ + self: { + demo: { + code: fs.readFileSync(path.join(__dirname, '../demo/sample.js'), 'utf8'), + source: fs.readFileSync(path.join(__dirname, '../demo/sample.md'), 'utf8') + } + } +}, null, 2));