b91a10a233
This should help point users to the correct version if they plan to install the release candidate, and it should help users find the existing docs for v1. |
||
|---|---|---|
| .github | ||
| api | ||
| bundler | ||
| docs | ||
| examples | ||
| module | ||
| ospec | ||
| performance | ||
| promise | ||
| querystring | ||
| render | ||
| request | ||
| router | ||
| stream | ||
| test-utils | ||
| tests | ||
| .deploy.enc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .npmignore | ||
| .travis.yml | ||
| browser.js | ||
| esm.js | ||
| hyperscript.js | ||
| index.js | ||
| LICENSE | ||
| mithril.js | ||
| mithril.min.js | ||
| mithril.min.mjs | ||
| mithril.mjs | ||
| mount.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| redraw.js | ||
| render.js | ||
| request.js | ||
| route.js | ||
| stream.js | ||
mithril.js 
What is Mithril?
A modern client-side Javascript framework for building Single Page Applications. It's small (8.88 KB gzipped), fast and provides routing and XHR utilities out of the box.
Mithril is used by companies like Vimeo and Nike, and open source platforms like Lichess 👍.
Mithril supports IE11, Firefox ESR, and the last two versions of Firefox, Edge, Safari, and Chrome. No polyfills required. 👌
Installation
CDN
<script src="https://unpkg.com/mithril"></script>
<!-- or -->
<script src="https://cdn.jsdelivr.net/npm/mithril/mithril.js"></script>
npm
# For the most recent stable version
$ npm install mithril --save
# For the most recent unstable version
$ npm install mithril@next --save
The "Getting started" guide is a good place to start learning how to use mithril.
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 has an active & welcoming community on Gitter, or feel free to ask questions on Stack Overflow using the mithril.js tag.
Contributing
There's a Contributing FAQ on the mithril site that hopefully helps, but if not definitely hop into the Gitter Room and ask away!
Thanks for reading!
🎁