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

docs: Fix some site weirdness

Browse source 
Fixes #2117
This commit is contained in:
Pat Cavit 2018-04-13 00:15:03 -07:00 • committed by Pierre-Yves Gérardy
parent 02f2732706
commit 0c54409d41
5 changed files with 26 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/installation.md
View file

@ -18,7 +18,7 @@ If you're new to Javascript or just want a very simple setup to get your feet we
### NPM ### NPM
```bash ```bash
$> npm install mithril --save $ npm install mithril --save
``` ```
--- ---
@ -27,13 +27,13 @@ $> npm install mithril --save
1. Initialize the directory as an npm package 1. Initialize the directory as an npm package
```bash ```bash
$> npm init --yes $ npm init --yes
``` ```
2. install required tools 2. install required tools
```bash ```bash
$> npm install mithril --save $ npm install mithril --save
$> npm install webpack webpack-cli --save-dev $ npm install webpack webpack-cli --save-dev
``` ```
3. Add a "start" entry to the scripts section in `package.json`. 3. Add a "start" entry to the scripts section in `package.json`.
@ -46,14 +46,13 @@ $> npm install webpack webpack-cli --save-dev
} }
``` ```
3. Create `src/index.js` 4. Create `src/index.js` file.
```js ```js
import m from "mithril"; import m from "mithril";
m.render(document.body, "hello world"); m.render(document.body, "hello world");
``` ```
4. create `index.html` 5. create `index.html`
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
<body> <body>
@ -61,12 +60,12 @@ m.render(document.body, "hello world");
</body> </body>
``` ```
5. run bundler 6. run bundler
```bash ```bash
$> npm start $ npm start
``` ```
6. open `index.html` in a browser 7. open `index.html` in a browser
#### Step by step #### Step by step
@ -268,7 +267,7 @@ m.render(document.body, "hello world")
TypeScript type definitions are available from DefinitelyTyped. They can be installed with: TypeScript type definitions are available from DefinitelyTyped. They can be installed with:
```bash ```bash
$> npm install @types/mithril --save-dev $ npm install @types/mithril --save-dev
``` ```
For example usage, to file issues or to discuss TypeScript related topics visit: https://github.com/MithrilJS/mithril.d.ts For example usage, to file issues or to discuss TypeScript related topics visit: https://github.com/MithrilJS/mithril.d.ts

6
docs/integrating-libs.md
View file

@ -1,9 +1,9 @@
# Integrating with Other Libraries # 3rd Party Integration
Integration with third party libraries or vanilla javascript code can be achieved via [lifecycle methods](lifecycle-methods.md). Integration with third party libraries or vanilla javascript code can be achieved via [lifecycle methods](lifecycle-methods.md).
- [Usage](#usage) ## Example
### Usage
```javascript ```javascript
var FullCalendar = { var FullCalendar = {

2
docs/learning-mithril.md
View file

@ -1,4 +1,4 @@
# Learning Mithril # Learning Resources
Links to Mithril learning content: Links to Mithril learning content:

9
docs/nav-guides.md
View file

@ -1,7 +1,9 @@
- Tutorials - Getting Started
- [Installation](installation.md)
- [Introduction](index.md) - [Introduction](index.md)
- [Installation](installation.md)
- [Tutorial](simple-application.md) - [Tutorial](simple-application.md)
- [Learning Resources](learning-mithril.md)
- [Getting Help](support.md)
- Resources - Resources
- [JSX](jsx.md) - [JSX](jsx.md)
- [ES6](es6.md) - [ES6](es6.md)
@ -9,8 +11,7 @@
- [Animation](animation.md) - [Animation](animation.md)
- [Testing](testing.md) - [Testing](testing.md)
- [Examples](examples.md) - [Examples](examples.md)
- [Integrating with Other Libraries](integrating-libs.md) - [3rd Party Integration](integrating-libs.md)
- [Learning Mithril](learning-mithril.md)
- Key concepts - Key concepts
- [Vnodes](vnodes.md) - [Vnodes](vnodes.md)
- [Components](components.md) - [Components](components.md)

2
docs/support.md
View file

@ -1,3 +1,3 @@
## Getting Help # Getting Help
Mithril has an active & welcoming community on [Gitter](https://gitter.im/mithriljs/mithril.js), or feel free to ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/mithril.js) using the `mithril.js` tag. Mithril has an active & welcoming community on [Gitter](https://gitter.im/mithriljs/mithril.js), or feel free to ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/mithril.js) using the `mithril.js` tag.