Update 60-second setup.md

.gitignore

@@ -2,4 +2,5 @@
 node_modules
 tmp
 build
-.sass-cache
+.sass-cache
+deploy.sh

.travis.yml

@@ -0,0 +1,10 @@
+language: node_js
+node_js:
+ - "0.10"
+before_script:
+ - npm install -g grunt-cli; chmod u+x deploy-to-gh-pages.sh; grunt build
+script: ./deploy-to-gh-pages.sh
+env:
+ global:
+  - GH_REF: github.com/RactiveJS/docs.ractivejs.org.git
+  - secure: AXOggwbE9d5bcLlAXQrpjc7EQz0qgpkYI8JICzNFwh9I7pqDy1BAg1nC8nc0c1Pyd/HTZH+4hkSO3vjuffTEdV7Nb/gEqo2Wu8lnB/NfAx6bNvMPK0rp54qc9kLr93m0i0ttDDnT3XoLdY7c9T3AFWHTF4c8y9ihvAqx+f4LaB8=

Gruntfile.js

@@ -19,7 +19,7 @@ module.exports = function ( grunt ) {
 
 			docs: {
 				files: 'docs/**/*',
-				tasks: [ 'dir2json', 'render' ]
+				tasks: [ 'spelunk', 'render' ]
 			}
 		},
 
@@ -37,7 +37,7 @@ module.exports = function ( grunt ) {
 			files: [ 'build/', 'tmp/' ]
 		},
 
-		dir2json: {
+		spelunk: {
 			posts: {
 				root: 'docs',
 				dest: 'tmp/docs.json'
@@ -57,95 +57,12 @@ module.exports = function ( grunt ) {
 	});
 
 	grunt.loadNpmTasks( 'grunt-contrib-watch' );
-	grunt.loadNpmTasks( 'grunt-contrib-sass' );
+	grunt.loadNpmTasks( 'grunt-sass' );
 	grunt.loadNpmTasks( 'grunt-contrib-clean' );
 	grunt.loadNpmTasks( 'grunt-contrib-copy' );
-	grunt.loadNpmTasks( 'grunt-dir2json' );
-
-
-	grunt.registerTask( 'render', function () {
-
-		var Ractive, docs, version, versionedDocs, pageName, slug, page, pages, slugs;
-
-		Ractive = require( 'ractive' );
-
-		docs = grunt.file.readJSON( 'tmp/docs.json' );
-
-		// render index page
-		render( 'index', {}, null, 'index' );
-
-		for ( version in docs ) {
-			versionedDocs = docs[ version ];
-			pages = [];
-			slugs = {};
-
-			for ( pageName in versionedDocs ) {
-				if ( pageName.charAt( 0 ) !== '_' ) {
-					page = processPage( versionedDocs[ pageName ], version, pageName, versionedDocs._home );
-					pages.push( page );
-
-					if ( slugs[ page.slug ] ) {
-						throw new Error( 'You cannot have multiple pages with the same slug (' + page.slug + ')' );
-					}
-					slugs[ page.slug ] = true;
-				}
-			}
-
-			pages.reverse();
-
-			// render individual posts
-			pages.forEach( renderPage.bind( null, version ) );
-
-			// render index
-			render( 'version-index', { home: versionedDocs._home }, version, 'index' );
-
-			// render page list
-			render( 'pages', { pages: pages }, version, 'pages' );
-		}
-
-		function renderPage ( version, page ) {
-			render( 'page', { page: page }, version, page.slug );
-		}
-
-		function writeFile ( version, fileName, content ) {
-			var path = [ 'build' ];
-			if ( version ) {
-				path.push( version );
-			}
-			path.push( fileName + '.html' );
-			grunt.file.write( path.join( '/' ), content );
-		}
-
-		function render ( templateName, data, version, fileName ) {
-			var cache, template, rendered, logMessage;
-
-			logMessage = [ "Rendering " ];
-			if ( version ) {
-				logMessage.push( version + "/" );
-			}
-			logMessage = logMessage.concat( fileName + ".html", " as [ ", templateName, " ]" );
-			console.log( logMessage.join( '' ) );
-
-
-			cache = render.cache || ( render.cache = {} );
-			template = cache[ templateName ] ||
-				( cache[ templateName ] = grunt.file.read( 'templates/' + templateName + '.html' ) );
-			rendered = new Ractive({
-				template: template,
-				data: data,
-				delimiters: [ '[[', ']]' ],
-				tripleDelimiters: [ '[[[', ']]]' ],
-				preserveWhitespace: true
-			}).toHTML();
-
-			writeFile( version, fileName, rendered );
-			if ( version === grunt.config( 'latest' ) ) {
-				writeFile( 'latest', fileName, rendered );
-			}
-		}
-
-	});
+	grunt.loadNpmTasks( 'grunt-spelunk' );
 
+	grunt.loadTasks( 'tasks' );
 
 	grunt.registerTask( 'default', [
 		'build',
@@ -154,64 +71,10 @@ module.exports = function ( grunt ) {
 
 	grunt.registerTask( 'build', [
 		'clean',
-		'dir2json',
+		'spelunk',
 		'render',
 		'sass',
 		'copy'
 	]);
 
-};
-
-function processPage ( page, version, name, homePath ) {
-	var markdown;
-
-	return {
-		version: version,
-		name: name,
-		slug: slugify( name ),
-		html: postprocess( require( 'marked' )( preprocessMarkdown( page, homePath ) ) )
-	};
-}
-
-function preprocessMarkdown ( markdown, homePath ) {
-
-	// breadcrumbs
-	markdown = markdown.replace( /^(.+)$/m, function ( match, breadcrumbs ) {
-		return '<div class="breadcrumbs">' + breadcrumbs.replace( / > /g, ' &raquo; ' ) + '</div>';
-	});
-
-	// specially treat [[Home]] link
-	markdown = markdown.replace( /\[\[Home\]\]/g, '[Home](' + homePath + ')' );
-
-	// turn [[My link]] into [My link](my-link)
-	markdown = markdown.replace( /\[\[([^\]]+)\]\]/g, function ( match, link ) {
-		return '[' + link + '](' + slugify( link ) + ')';
-	});
-
-	// process github-style code blocks
-	markdown = markdown.replace( /```([a-z]+)?\n([\s\S]+?)\n```/g, function ( match, language, content ) {
-		content = content
-			.replace( /\t/g, '  ' )
-			.replace( /</g, '&lt;' )
-			.replace( />/g, '&gt;' );
-
-		return '<pre' + ( language ? ' class="prettyprint lang-' + language + '"' : '' ) + '>' + content + '</pre>';
-	});
-
-	return markdown;
-}
-
-function postprocess ( html ) {
-	return html.replace( / - /g, ' &ndash; ' );
-}
-
-function slugify ( str ) {
-	if ( !str ) {
-		return '';
-	}
-	return str.toLowerCase()
-		.replace( /[^a-z]/g, '-' )
-		.replace( /-{2,}/g, '-' )
-		.replace( /^-/, '' )
-		.replace( /-$/, '' );
-}
+};

deploy-to-gh-pages.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# deploy script based on https://medium.com/philosophy-logic/53a8270e87db
+if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then
+	echo "Deploy script running..."
+	( cd build
+		# grunt copy task doesn't seem to work here...
+		# cp -r ../root/* ./
+
+		git init
+		git config user.name "Travis-CI"
+		git config user.email "[email protected]"
+		git add .
+		git commit -m "Deployed to Github Pages"
+
+		echo "Pushing to gh-pages"
+		git push --force "https://${GH_TOKEN}@${GH_REF}" master:gh-pages > /dev/null 2>&1
+	)
+fi

docs/0.3.9/60-second setup.md

@@ -16,7 +16,7 @@ Create a folder with a blank `index.html` page:
 </html>
 ```
 
-Download the [latest released version of Ractive.js](https://raw.github.com/RactiveJS/Ractive/master/Ractive.js) and put it in the same folder as `index.html`. Include it with a script tag just before the closing `</body>` tag:
+Download the [latest released version](http://cdn.ractivejs.org/latest/Ractive.js) or the [latest released minified version of Ractive.js](http://cdn.ractivejs.org/latest/Ractive.min.js) and put it in the same folder as `index.html`. Include it with a script tag just before the closing `</body>` tag:
 
 ```html
 <body>
@@ -79,10 +79,10 @@ Everything is in place to create a Ractive. Add another script tag at the bottom
 
 Open the page in a browser. You should see a 'Hello, world!' message. If you open the console and type `ractive.set('recipient', 'Jim')` the text will update.
 
-That's it - you're in business.
+That's it - you're in business!
 
 ### Next steps
 
 * You could pass in a template string as the `template` option, rather than the ID of a script tag containing the template. In that case, if your template is more than a couple of lines you'll probably want to keep it in a separate file and load it (e.g. with `$.ajax`, if you're using jQuery)
 * As your app grows in complexity, you'll want to keep your application code (i.e. the bit that calls `new Ractive()`) in a separate file. You can also [use Ractive with RequireJS](using-ractive-with-requirejs).
-* Work your way through the [tutorials](http://learn.ractivejs.org) to learn how to use Ractive. You can also consult the [[API reference]].
+* Work your way through the [tutorials](http://learn.ractivejs.org) to learn how to use Ractive. You can also consult the [[API reference]].

docs/0.3.9/API reference.md

@@ -25,8 +25,8 @@ Create a new Ractive instance. See [[Initialisation options]] for a breakdown of
 ## Instance properties
 
 * [[ractive.nodes]]
-* [ractive.transitions](ractive.transitions %28instance%29)
-* [ractive.partials](ractive.partials %28instance%29)
+* [[ractive.transitions (instance)]]
+* [[Ractive.partials (instance)]]
 
 
 ## Instance events
@@ -42,8 +42,8 @@ See [[Events]].
 ## Plugins and shared properties
 
 * [[Ractive.adaptors]]
-* [[Ractive.eventDefinitions]]
+* [[Ractive.events]]
 * [[Ractive.easing]]
-* [Ractive.partials](Ractive.partials %28global%29)
-* [Ractive.transitions](Ractive.transitions %28global%29)
-...more to come...
+* [[Ractive.partials (global)]]
+* [[Ractive.transitions (global)]]
+...more to come...

docs/0.3.9/Array modification.md

@@ -24,7 +24,7 @@ ractive = new Ractive({
 list.push( 'd' ); // adds a new list item - <li>d</li>
 ```
 
-You can disable this behaviour by passing in `modifyArrays: false` as an [initialisation option](Initialisation options).
+You can disable this behaviour by passing in `modifyArrays: false` as an [initialisation option](initialisation-options).
 
 
 ## How it works

docs/0.3.9/Events.md

@@ -73,7 +73,7 @@ Proxy event handlers receive an `event` argument. This isn't the same as the `ev
 
 Because of the way proxy events work, they more or less eliminate the need for event delegation.
 
-Any standard DOM event that an element supports can be used (e.g. `on-mouseover='highlight'`, `on-touchstart='dragstart'`, `on-blur='submit'`, `on-error='loadFallbackImage'`, and so on), as can non-standard events defined in [[Ractive.eventDefinitions]] such as `on-tap`.
+Any standard DOM event that an element supports can be used (e.g. `on-mouseover='highlight'`, `on-touchstart='dragstart'`, `on-blur='submit'`, `on-error='loadFallbackImage'`, and so on), as can non-standard events defined in [[ractive-events]] such as `on-tap`.
 
 *TODO - chained proxy events, additional arguments in custom event definitions*
 

docs/0.3.9/Expressions.md

@@ -1,6 +1,12 @@
 [[Home]] > [[Glossary]] > [[Expressions]]
 
-Expressions allow you to use logic within a template. At their simplest, that may just mean a basic arithmetic operation, such as converting to percentages, or making your [index references](Mustaches#index-references) start at 1 rather than 0:
+Expressions allow you to use logic within a template. At their simplest, that may just mean a basic arithmetic operation, such as converting to percentages, but there are a variety of more complex uses, such as the examples below.
+
+These examples are plucked from the air - whether they would be useful or not in real life depends on what you're trying to do. The point is that you can include more of your view logic at the declarative layer - the template - where it's easier to *reason about*.
+
+## Examples
+
+### Making your [index references](mustaches#index-references) start at 1 rather than 0:
 
 ```html
 <div class='bar-chart'>
@@ -10,19 +16,29 @@ Expressions allow you to use logic within a template. At their simplest, that ma
 </div>
 ```
 
-Or it could mean formatting a currency so that `1.79` renders as `£1.79p`:
+### Formatting a currency
+
+In this case, so that `1.79` renders as `£1.79p`
 
 ```html
 <p>Price: <strong>{{ format( price ) }}</strong></p>
 ```
 
-Or it could mean adding a class based on some condition:
+### Adding a class to an element based on a condition
 
 ```html
 <a class='button {{ active ? "on" : "off" }}'>switch</a>
 ```
 
-Or it could mean filtering a list to exclude certain records:
+### A template section that depends on a condition
+
+```
+{{# status === 'running' }}
+   <p>Running</p>
+{{/ end of filter }}
+```
+
+### Filtering a list to exclude certain records
 
 ```html
 <ul>
@@ -32,9 +48,6 @@ Or it could mean filtering a list to exclude certain records:
 </ul>
 ```
 
-These are all examples casually plucked from the air - whether they would be useful or not in real life depends on what you're trying to do. The point is that you can include more of your view logic at the declarative layer - the template - where it's easier to *reason about*.
-
-
 ## Valid expressions
 
 These are, of course, JavaScript expressions. Almost any valid JavaScript expression can be used, with a few exceptions:
@@ -44,7 +57,7 @@ These are, of course, JavaScript expressions. Almost any valid JavaScript expres
 * No function literals (i.e. anything that involves the `function` keyword)
 * No regular expression literals (this may change in future!)
 
-Aside from a subset of global objects (e.g. `Math`, `Array`, `parseInt`, `encodeURIComponent` - full list below), any references must be to properties (however deeply nested) of the Ractive instance's data, rather than arbitrary variables. Reference resolution follows the [normal process](References).
+Aside from a subset of global objects (e.g. `Math`, `Array`, `parseInt`, `encodeURIComponent` - full list below), any references must be to properties (however deeply nested) of the Ractive instance's data, rather than arbitrary variables. Reference resolution follows the [normal process](references).
 
 
 ## Does this use `eval`?
@@ -111,4 +124,4 @@ In regular mustache, we have something called the *implicit iterator* - `{{.}}`
 * `null`
 * `parseFloat`
 * `parseInt`
-* `undefined`
+* `undefined`

docs/0.3.9/Glossary.md

@@ -4,18 +4,19 @@ Ractive aims to be as self-explanatory as possible - you shouldn't have to trawl
 
 That said, if you're curious about some of the inner workings of Ractive, and want to better understand some of the concepts it uses, these pages may help.
 
-* [[Mustaches]]
-* [[References]]
-* [[Keypaths]]
-* [[Parallel DOM]]
+* [[Adaptors]]
+* [[Array modification]]
+* [[Components]]
+* [[Decorators]]
 * [[Dependants]]
 * [[Expressions]]
+* [[Keypaths]]
+* [[Magic mode]]
+* [[Mustaches]]
 * [[Observers]]
+* [[Parallel DOM]]
+* [[Partials]]
+* [[References]]
+* [[Templates]]
 * [[Transitions]]
 * [[Two‐way binding]]
-* [[Templates]]
-* [[Partials]]
-* [[Adaptors]]
-* [[Array modification]]
-* [[Magic mode]]
-* [[Components]]