Repository files navigation

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

A modern client-side JavaScript framework for building Single Page Applications. It's small (8.92 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. 👌

<!-- Development: whichever you prefer --><scriptsrc="https://unpkg.com/mithril/mithril.js"></script><scriptsrc="https://cdn.jsdelivr.net/npm/mithril/mithril.js"></script><!-- Production: whichever you prefer --><scriptsrc="https://unpkg.com/mithril/mithril.min.js"></script><scriptsrc="https://cdn.jsdelivr.net/npm/mithril/mithril.min.js"></script>

npm install mithril --save

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:

$ npm install @types/mithril --save-dev

Documentation lives onmithril.js.org.

You may be interested in theAPI Docs, aSimple Application, or perhaps someExamples.

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

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

Thanks for reading!

🎁