Core Topics

• Installation
• Getting Started
• Routing
• Web Services
• Components

Advanced Topics

• The Auto-Redrawing System
• Integrating with Other Libraries
• Compiling Templates

Misc

• Differences from Other MVC Frameworks
• Benchmarks
• Good Practices
• Useful Tools

Installation

Mithril is available from a variety of sources:

---

Direct download

You can download a zip of the latest version version here.

Links to older versions can be found in the change log.

In order to use Mithril, extract it from the zip file and point a script tag to the .js file:

<script src="mithril.min.js"></script>

Note that in order to support older versions of IE, you need to include some shims.

---

CDNs (Content Delivery Networks)

You can also find Mithril in cdnjs and jsDelivr.

Content delivery networks allow the library to be cached across different websites that use the same version of the framework, and help reduce latency by serving the files from a server that is physically near the user's location.

cdnjs

<script src="//cdnjs.cloudflare.com/ajax/libs/mithril/0.1.25/mithril.min.js"></script>

jsDelivr

<script src="//cdn.jsdelivr.net/mithril/0.1.25/mithril.min.js"></script>

---

NPM

NPM is the default package manager for NodeJS. If you're using NodeJS already or planning on using Grunt to create a build system, you can use NPM to conveniently keep up-to-date with Mithril versions.

Assuming you have NodeJS installed, you can download Mithril by typing this:

npm install mithril

Then, to use Mithril, point a script tag to the downloaded file:

<script src="/node_modules/mithril/mithril.min.js"></script>

---

Bower

Bower is a package manager for NodeJS. If you're using NodeJS already or planning on using Grunt to create a build system, you can use Bower to conveniently keep up-to-date with Mithril versions.

Assuming you have NodeJS installed, you can install Bower by typing this in the command line:

npm install -g bower

And you can download Mithril by typing this:

bower install mithril

Then, to use Mithril, point a script tag to the downloaded file:

<script src="/bower_components/mithril/mithril.min.js"></script>

---

Component

Component is another package manager for NodeJS. If you're using NodeJS already or planning on using Grunt to create a build system, you can use Component to conveniently keep up-to-date with Mithril versions.

Assuming you have NodeJS installed, you can install Component by typing this in the command line:

npm install -g component

And you can download Mithril by typing this:

component install lhorie/mithril

Then, to use Mithril, point a script tag to the downloaded file:

<script src="/components/lhorie/mithril/master/mithril.js"></script>

---

Rails

Jordan Humphreys created a gem to allow integration with Rails:

Mithril-Rails

It includes support for the MSX HTML templating syntax from Jonathan Buchanan.

---

Github

You can also fork the latest stable project directly from Github.

If you want to use the bleeding edge version, you can fork the development repository.

Note that Mithril uses the next branch as the stable branch, instead of master, because contributors usually use master for pull requests. Therefore, the master branch should be considered unstable, and should not be used.

Be aware that even though Mithril has tests running in a continuous integration environment, the bleeding edge version might occasionally break. If you're interested in helping improve Mithril, you're welcome to use the bleeding edge version and report any bugs that you find.

In order to update a forked version of Mithril, follow the instructions on this page.