From 4d41f7a40308cb043dcbcbd634dabe56f142a404 Mon Sep 17 00:00:00 2001 From: Leo Horie Date: Mon, 31 Mar 2014 16:07:24 -0400 Subject: [PATCH] add docs about msx --- archive/v0.1.1/tools.html | 18 ++++++++++++++++-- docs/tools.md | 27 +++++++++++++++++++++++++-- 2 files changed, 41 insertions(+), 4 deletions(-) diff --git a/archive/v0.1.1/tools.html b/archive/v0.1.1/tools.html index 260477ed..26faba39 100644 --- a/archive/v0.1.1/tools.html +++ b/archive/v0.1.1/tools.html @@ -44,10 +44,24 @@

Tools

-

HTML to Mithril Template Converter

-

If you already have your HTML written and want to convert it into a Mithril template, use the tool below.

+

HTML-to-Mithril Template Converter

+

If you already have your HTML written and want to convert it into a Mithril template, you can use the tool below for one-off manual conversion.

Template Converter

+

Automatic HTML-to-Mithril Template Converter

+

There's a tool called MSX by Jonathan Buchanan that allows you to write templates using HTML syntax, and then automatically compile them to Javascript when files change.

+

It is useful for teams where styling and functionality are done by different people, and for those who prefer to maintain templates in HTML syntax.

+

The tool allows you to write code like this:

+
todo.view = function(ctrl) {
+    return <html>
+        <body>
+            <input onchange={m.withAttr("value", ctrl.description)} value={ctrl.description()}/>
+            <button onclick={ctrl.add.bind(ctrl, ctrl.description)}>Add</button>
+        </body>
+    </html>
+};
+

Note, however, that since the code above is not valid Javascript, this syntax can only be used with a preprocessor build tool such as the provided Gulp.js script.

+

Mithril Template Compiler

You can pre-compile Mithril templates to make them run faster. For more information see this page:

Compiling Templates

diff --git a/docs/tools.md b/docs/tools.md index 202de480..64cf8250 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -1,13 +1,36 @@ ## Tools -### HTML to Mithril Template Converter +### HTML-to-Mithril Template Converter -If you already have your HTML written and want to convert it into a Mithril template, use the tool below. +If you already have your HTML written and want to convert it into a Mithril template, you can use the tool below for one-off manual conversion. [Template Converter](tools/template-converter.html) --- +### Automatic HTML-to-Mithril Template Converter + +There's a tool called [MSX by Jonathan Buchanan](https://github.com/insin/msx) that allows you to write templates using HTML syntax, and then automatically compile them to Javascript when files change. + +It is useful for teams where styling and functionality are done by different people, and for those who prefer to maintain templates in HTML syntax. + +The tool allows you to write code like this: + +```javascript +todo.view = function(ctrl) { + return + + + + + +}; +``` + +Note, however, that since the code above is not valid Javascript, this syntax can only be used with a preprocessor build tool such as the provided [Gulp.js](http://gulpjs.com) script. + +--- + ### Mithril Template Compiler You can pre-compile Mithril templates to make them run faster. For more information see this page: