'); } 38 | | P_END 39 | { yy.c('
\n'); } 40 | | PRE_START 41 | { yy.c($1); } 42 | | PRE_END 43 | { yy.c($1); } 44 | | LIST_START 45 | { yy.c($1); } 46 | | LIST_ITEM 47 | { yy.c($1); } 48 | | LIST_END 49 | { yy.c($1); } 50 | ; 51 | 52 | -------------------------------------------------------------------------------- /test/preformatted.test.js: -------------------------------------------------------------------------------- 1 | var jadedown = require('./../lib/jadedown') 2 | , assert = require('assert'); 3 | 4 | module.exports = { 5 | 'test HTML is escaped in pre tags': function() { 6 | var expected = 'This is a <tag>' 7 | , input = '
This is a'; 8 | 9 | assert.equal(expected, jadedown(input)); 10 | }, 11 | 12 | 'test HTML is escaped in multiline pre tags': function() { 13 | var expected = '
Example:
\n\nThis is a <tag>\n' 14 | , input = 'Example:\n
\nThis is a'; 15 | assert.equal(expected, jadedown(input)); 16 | }, 17 | 18 | 'test HTML is escaped in code tags': function() { 19 | // I'm not sure if this should insert paragraphs or not 20 | var expected = '\n
This is a <tag>'
21 | , input = 'This is a ';
22 |
23 | assert.equal(expected, jadedown(input));
24 | },
25 |
26 | 'test HTML is escaped in code shorthand': function() {
27 | var expected = 'This is a <tag>
17 | h3 This is a header 18 |19 | 20 | This has been retained in Jadedown. 21 | 22 | Jade uses CSS selectors and brackets to contain attributes: 23 | 24 |
25 | h3.className(style="color: blue") This is a header 26 |27 | 28 | Jadedown uses the same conventions. 29 | 30 | h2 Shorthand 31 | 32 | * Code can be written with backticks
`var a = 1;`
33 | * Asterisks and underscores are used for bold and italic
34 | * Other lines are converted to paragraphs
35 | * Unordered lists start with asterisks
36 | * Ordered lists start with a hash
37 |
38 | h2 Plans
39 |
40 | # Inline tags
41 | # Tags with classes
42 | # Tags with IDs
43 | # Full test suite
44 | # Benchmarks
45 |
46 | And this is an image:
47 |
48 | img(src="http://example.com/image.png")
49 |
50 |
--------------------------------------------------------------------------------
/test/shorthand.test.js:
--------------------------------------------------------------------------------
1 | var jadedown = require('./../lib/jadedown')
2 | , fs = require('fs')
3 | , assert = require('assert');
4 |
5 | module.exports = {
6 | 'test strong': function() {
7 | var expected = 'Example 1
' 8 | , input = '*Example 1*'; 9 | 10 | assert.equal(expected, jadedown(input)); 11 | }, 12 | 13 | 'test multiple strong': function() { 14 | var expected = 'Important: The lazy fox
' 15 | , input = '*Important*: The *lazy fox*'; 16 | 17 | assert.equal(expected, jadedown(input)); 18 | }, 19 | 20 | 'test em': function() { 21 | var expected = 'Example 1
' 22 | , input = '_Example 1_'; 23 | 24 | assert.equal(expected, jadedown(input)); 25 | }, 26 | 27 | 'test code': function() { 28 | var expected = 'var a = 1 * 5;
Given that var a = 1 * 5; and var b = Math.PI;, then:
Example 1 and Example 2 are links
' 50 | , input = '(http://example.com)[Example 1] and (http://example.com/2)[Example 2] are links'; 51 | 52 | assert.equal(expected, jadedown(input)); 53 | } 54 | }; 55 | 56 | -------------------------------------------------------------------------------- /lib/nodes.js: -------------------------------------------------------------------------------- 1 | function aliases(tag) { 2 | switch (tag) { 3 | case 'bq': 4 | return 'blockquote'; 5 | break; 6 | 7 | default: 8 | return tag; 9 | } 10 | } 11 | 12 | function Nodes() { 13 | this.openTags = []; 14 | } 15 | 16 | Nodes.prototype = { 17 | pushOpenTag: function(tag) { 18 | this.openTags.push(tag); 19 | }, 20 | 21 | popOpenTag: function() { 22 | return ''; 23 | }, 24 | 25 | makeAttr: function($1) { 26 | var attr = [] 27 | , id = $1.selector ? $1.selector.match(/#([^.([]*)/) : null 28 | , classes = $1.selector; 29 | 30 | if (id && id[1]) { 31 | attr.push('id="' + id[1] + '"'); 32 | classes = classes.replace(/#([^.([]*)/, ''); 33 | } 34 | 35 | if (classes) { 36 | classes = classes.split(/\./); 37 | if (classes.length > 0) { 38 | attr.push('class="' + classes.join(' ').trim() + '"'); 39 | } 40 | } 41 | 42 | if ($1.attr) { 43 | attr.push($1.attr); 44 | } 45 | 46 | if (attr.length === 0) { 47 | return ''; 48 | } else { 49 | return ' ' + attr.join(' '); 50 | } 51 | }, 52 | 53 | makeTag: function($1) { 54 | var attr = this.makeAttr($1); 55 | $1.tag = aliases($1.tag); 56 | 57 | if (!$1.html) { 58 | this.pushOpenTag($1.tag); 59 | // TODO: self-closing, plus on/off for xhtml/html 60 | var end = $1.tag === 'img' ? '/>' : '>'; 61 | return '<' + $1.tag + attr + end; 62 | } else { 63 | return '<' + $1.tag + attr + '>' + $1.html + ''; 64 | } 65 | }, 66 | 67 | TAG: function($1) { 68 | return this.makeTag($1); 69 | }, 70 | 71 | LINK: function($1) { 72 | return this.makeTag($1); 73 | }, 74 | 75 | BLOCK_TAG: function($1) { 76 | return this.makeTag($1); 77 | }, 78 | 79 | BLOCK_END: function() { 80 | return this.popOpenTag() + '\n'; 81 | } 82 | }; 83 | 84 | var nodes = new Nodes(); 85 | 86 | if (typeof module !== 'undefined') { 87 | module.exports = nodes; 88 | } 89 | -------------------------------------------------------------------------------- /test/blocks.test.js: -------------------------------------------------------------------------------- 1 | var jadedown = require('./../lib/jadedown') 2 | , fs = require('fs') 3 | , assert = require('assert'); 4 | 5 | module.exports = { 6 | 'test line start': function() { 7 | var expected = 'This is a quote' 8 | , input = 'blockquote This is a quote\n'; 9 | 10 | assert.equal(expected, jadedown(input)); 11 | }, 12 | 13 | 'test line start and inline': function() { 14 | var expected = '
This is a quote' 15 | , input = 'blockquote This is a _quote_\n'; 16 | 17 | assert.equal(expected, jadedown(input)); 18 | }, 19 | 20 | 'test space indentation becomes code': function() { 21 | var expected = '
Here is some code:
\nvar a = 1;Here is some code:
\nvar a = 1;Here is some code:
\nvar a = 1;\nfunction() { return a * 100; }Here is some code:
\nvar a = 1; a++; console.log(a);\nExample.
' 43 | , input = 'Here is some code:\n var a = 1; a++; console.log(a);\nExample.\n'; 44 | 45 | assert.equal(expected, jadedown(input)); 46 | }, 47 | 48 | 'test tab indentation becomes code': function() { 49 | var expected = 'Here is some code:
\nvar a = 1;Example:
Example 1' 8 | , input = 'Example: blockquote[Example 1]'; 9 | 10 | assert.equal(expected, jadedown(input)); 11 | }, 12 | 13 | 'test tags with attributes': function() { 14 | var expected = '' 15 | , input = 'a(href="http://example.com")[Example 1]'; 16 | 17 | assert.equal(expected, jadedown(input)); 18 | }, 19 | 20 | 'test tags with a class': function() { 21 | var expected = '' 22 | , input = 'a.example(href="http://example.com")[Example 1]'; 23 | 24 | assert.equal(expected, jadedown(input)); 25 | }, 26 | 27 | 'test tags with an id': function() { 28 | var expected = '' 29 | , input = 'a#nav(href="http://example.com")[Example 1]'; 30 | 31 | assert.equal(expected, jadedown(input)); 32 | }, 33 | 34 | 'test tags with classes': function() { 35 | var expected = '' 36 | , input = 'a.example1.example2(href="http://example.com")[Example 1]'; 37 | 38 | assert.equal(expected, jadedown(input)); 39 | }, 40 | 41 | 'test tags with classes and an id': function() { 42 | var expected = '' 43 | , input = 'a#id.example1.example2(href="http://example.com")[Example 1]'; 44 | 45 | assert.equal(expected, jadedown(input)); 46 | }, 47 | 48 | 'test multiple tags with classes and an id': function() { 49 | var expected = '' 50 | , input = ''; 51 | 52 | expected += '
'; 53 | expected += 'Link 1: Example 1 '; 54 | expected += 'and link 2 Example 2
'; 55 | 56 | input += 'Link 1: a#id.example1.example2(href="http://example.com")[Example 1] '; 57 | input += 'and link 2 a#id2.example1.example2(href="http://example.com/2")[Example 2]'; 58 | 59 | assert.equal(expected, jadedown(input)); 60 | } 61 | }; 62 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Jadedown 2 | 3 | An *experiment* to combine [Jade](http://jade-lang.com/) and [Markdown](http://daringfireball.net/projects/markdown/). 4 | 5 | This has been developed purely for fun to see what I can do with Jade's convenient selector-based syntax. 6 | 7 | ## Syntax 8 | 9 | Basic principles: 10 | 11 | * Tags take the form: `tagName#id.class1.class2(attr1="value", attr2="value 2")[innerHTLM]` 12 | * If a line starts with a recognised tag, then the line is wrapped in that tag. For example: `h3 This is a header` 13 | * If a line starts with `*` or `#` it is a unordered or ordered list 14 | * There is also shorthand for commonly used tags, like strong, em, links, and code 15 | * Content in pre-formatted tags (pre, code) is escaped 16 | 17 | Shorthand: 18 | 19 | * Code can be written with backticks: `var a = 1;` 20 | * Code blocks can be created by using four spaces or a tab at the start of each line 21 | * Asterisks and underscores are used for bold and italic 22 | * Other lines are converted to paragraphs 23 | * Unordered lists start with asterisks 24 | * Ordered lists start with a hash 25 | 26 | ## Examples 27 | 28 | There are some rough examples I used to develop the basic lexer and parser; these can be found in `test/fixtures/`. 29 | 30 | ## Installation 31 | 32 | As an npm module: 33 | 34 | npm install -g jadedown 35 | 36 | There's also a browser version in jadedown.js. 37 | 38 | 39 | 42 | 43 | ## Usage 44 | 45 | This library comes with a command-line script: 46 | 47 | jadedown file.jd 48 | 49 | Or as a CommonJS module: 50 | 51 | var jadedown = require('jadedown'); 52 | jadedown('h3 Example'); 53 | 54 | ## License 55 | 56 | Copyright (C) 2011 by Alex R. Young 57 | 58 | Permission is hereby granted, free of charge, to any person obtaining a copy 59 | of this software and associated documentation files (the "Software"), to deal 60 | in the Software without restriction, including without limitation the rights 61 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 62 | copies of the Software, and to permit persons to whom the Software is 63 | furnished to do so, subject to the following conditions: 64 | 65 | The above copyright notice and this permission notice shall be included in 66 | all copies or substantial portions of the Software. 67 | 68 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 69 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 70 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 71 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 72 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 73 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 74 | THE SOFTWARE. 75 | 76 | -------------------------------------------------------------------------------- /lib/lexer.l: -------------------------------------------------------------------------------- 1 | %x b 2 | %x p 3 | %x pre 4 | %x preblock 5 | %x li 6 | %x ol 7 | 8 | %% 9 | 10 | ^"*"\s+ %{ 11 | this.begin('li'); 12 | yytext = '' + yy.h(yy.lexer.matches[2])
101 | this.begin('preblock');
102 | return 'TEXT';
103 | %}
104 |
105 | \n+ %{
106 | return 'EOL';
107 | %}
108 |
109 | <> %{
110 | yytext = '