Repository: MithrilJS/mithril.js

Stars: 14536

README.md Copy Chapter

Mithril.js

  
  
  
  
  

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

What is Mithril.js? Copy Chapter

A modern client-side JavaScript framework for building Single Page Applications. It's small (<!-- size -->8.93 KB<!-- /size --> 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 Firefox ESR, and the last two versions of Firefox, Edge, Safari, and Chrome. No polyfills required. 👌

Installation Copy Chapter

CDN Copy Section

<!-- 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 Copy Section

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 Copy Chapter

Documentation lives on mithril.js.org.

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

Getting Help Copy Chapter

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

Contributing Copy Chapter

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!

🎁