vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add documentation for cdn and bower

Browse source
This commit is contained in:
Leo Horie 2014-03-22 15:53:44 -04:00
parent ab494829c6
commit 0ef8c8beb6
19 changed files with 173 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/getting-started.md
View file

@ -16,7 +16,7 @@ However, using its entire toolset idiomatically can bring lots of benefits: lear
## A Simple Application
Getting started is surprisingly boilerplate-free:
Once you have a [copy of Mithril](installation.md), getting started is surprisingly boilerplate-free:
```markup
<!doctype html>

61
docs/installation.md Normal file
View file

@ -0,0 +1,61 @@
## Installation
Mithril is available from a variety of sources:
---
### Direct download
You can [download a zip of the latest version version here](http://lhorie.github.io/mithril/mithril.min.zip).
Links to older versions can be found in the [change log](change-log.html)
In order to use Mithril, extract it from the zip file and point a script tag to the `.js` file:
```markup
<script src="mithril.min.js"></script>
```
---
### CDNs (Content Delivery Networks)
You can also find Mithril in [cdnjs](http://cdnjs.com/libraries/mithril/) and [jsdelivr](http://www.jsdelivr.com/#!mithril)
Content delivery networks allow the library to be cached across different websites that use the same version of the framework, and help reduce latency by serving the files from a server that is physically near the user's location.
#### CdnJs
```markup
<script src="//cdnjs.cloudflare.com/ajax/libs/mithril/$version/mithril.min.js"></script>
```
#### JsDelivr
```markup
<script src="//cdn.jsdelivr.net/mithril/$version/mithril.min.js"></script>
```
---
### Bower
[Bower](http://http://bower.io) is a package manager for [NodeJS](http://nodejs.org/). If you're using NodeJS already or planning on using [Grunt](http://gruntjs.com/) to create a build system, you can use Bower to conveniently keep up-to-date with Mithril versions.
Assuming you have NodeJS installed, you can install bower by typing this in the command line:
```
npm install -g bower
```
And you can download Mithril by typing this:
```
bower install mithril
```
Then, to use Mithril, point a script tag to the downloaded file:
```markup
<script src="bower_components/mithril/mithril.min.js"></script>
```

1
docs/layout/guide.html
View file

@ -23,6 +23,7 @@
<div class="col(3,3,12)">
<h2 id="core-topics">Core Topics</h2>
<ul>
<li><a href="installation.html">Installation</a></li>
<li><a href="getting-started.html">Getting Started</a></li>
<li><a href="routing.html">Routing</a></li>
<li><a href="web-services.html">Web Services</a></li>