* Minify stream, add stream stuff to releases again * Kill off a lot of tech debt, drop internal utilities from npm 1. Kill `module/`, internalize `bundler/`, privatize `test-utils/` We've been telling people to move elsewhere from these for a while, and it's about time we just pull the plug here and finally remove them. - We officially removed the bundler from the public API in v2.0, and that was the only one of these that was ever publicly documented. Usage should be low enough by now it shouldn't break anyone- I'm not seeing bundler bugs being reported anymore, either. - The `module/` utility was so narrow and caveat-filled that I'm not sure anyone really used it (even us core Mithril devs never really used it), and we only had it documented in the repo folder it lived in. I think only one bug was ever filed, and it's because it somehow ended up completely non-functional without any of us realizing it. - The test utilities were meant to be internal from day 1, but people started using it despite us core developers constantly telling people to look elsewhere and even the docs recommending specific alternatives without mention of our internal mocks. (Now if people would RTFM, that'd be nice...) 2. Add dedicated HTML test files to verify ospec and the promise polyfill, and ensure the promise tests are in pure ES5. These are made specially for those and should be much easier to just run now. 3. Fix the benchmark script to use the real DOM in browsers and to not require as many dependencies to create. Also, tweak them to be much more effective and precise on what's being tested. Previously, it was rendering to the HTML file itself, while now it's rendering to the `body`. This means in browsers, it's triggering layout and everything, benchmarking how well Mithril optimizes for style and layout recalcs, too. It also puts some pressure on the hyperscript parser attribute application, so that can be noticed as well. * Update dependencies |
||
|---|---|---|
| .github | ||
| api | ||
| docs | ||
| examples | ||
| ospec | ||
| pathname | ||
| performance | ||
| promise | ||
| querystring | ||
| render | ||
| request | ||
| scripts | ||
| stream | ||
| test-utils | ||
| tests | ||
| util | ||
| .deploy.enc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .npmignore | ||
| .travis.yml | ||
| browser.js | ||
| hyperscript.js | ||
| index.js | ||
| LICENSE | ||
| mithril.js | ||
| mithril.min.js | ||
| mount-redraw.js | ||
| 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 (9.79 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
<!-- Development: whichever you prefer -->
<script src="https://unpkg.com/mithril/mithril.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mithril/mithril.js"></script>
<!-- Production: whichever you prefer -->
<script src="https://unpkg.com/mithril/mithril.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mithril/mithril.min.js"></script>
npm
npm install mithril --save
The "Getting started" guide is a good place to start learning how to use mithril.
TypeScript type definitions are available from DefinitelyTyped. They can be installed with:
$ npm install @types/mithril --save-dev
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!
🎁