Mithril

A JavaScript Framework for Building Brilliant Applications

UI FrameworkVirtual DOM
MithrilJS/mithril.jsmithril.js.orgmithril

README

Mithril.js

npm Version   License   npm Downloads   Build Status   Donate at OpenCollective   Zulip, join chat

- What is Mithril.js?
- Installation
- Documentation
- Getting Help
- Contributing

What is Mithril.js?


A modern client-side JavaScript framework for building Single Page Applications. It's small (10.05 KB gzipped), fast and provides routing and XHR utilities out of the box.

Mithril.js is used by companies like Vimeo and Nike, and open source platforms like Lichess 👍.

Mithril.js supports IE11, Firefox ESR, and the last two versions of Firefox, Edge, Safari, and Chrome. No polyfills required. 👌

Installation


CDN


  1. ``` html
  3. <script src="https://unpkg.com/mithril/mithril.js"></script>
  4. <script src="https://cdn.jsdelivr.net/npm/mithril/mithril.js"></script>
  5. <script src="https://unpkg.com/mithril/mithril.min.js"></script>
  6. <script src="https://cdn.jsdelivr.net/npm/mithril/mithril.min.js"></script>
  7. ```

npm


  1. ``` sh
  2. npm install mithril --save
  3. ```

The "Getting started" guide is a good place to start learning how to use Mithril.js.

TypeScript type definitions are available from DefinitelyTyped. They can be installed with:

  1. ``` sh
  2. $ npm install @types/mithril --save-dev
  3. ```

Documentation


Documentation lives on mithril.js.org.

You may be interested in the API Docs, a Simple Application, or perhaps some Examples.

Getting Help


Mithril.js has an active & welcoming community on Zulip, or feel free to ask questions on Stack Overflow using themithril.js tag.

Contributing


There's a Contributing FAQ on the Mithril.js site that hopefully helps, but if not definitely hop into the Zulip stream and ask away!


Thanks for reading!

🎁