diff --git a/.travis.yml b/.travis.yml index 97971661..181b73f3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,46 +28,47 @@ script: - npm run perf # After a successful build commit changes back to repo -after_success: - - | - # Set up SSH environment - $(npm bin)/set-up-ssh \ - --key "$encrypted_016049456622_key" \ - --iv "$encrypted_016049456622_iv" \ - --path-encrypted-key "./.deploy.enc" - - # Commit bundle changes generated in before_script step - # --commands is a weird no-op but required for commit-changes to run - # --branch arg is to ensure this only runs against the `next` branch - $(npm bin)/commit-changes \ - --commands "echo committing" \ - --commit-message "Bundled output for commit $TRAVIS_COMMIT [skip ci]" \ - --branch "next" - - # Only want to commit docs when building pushes on master & - # this doesn't have the built-in branch protection like commit-changes - if [ "$TRAVIS_EVENT_TYPE" == "push" ] && \ - [ "$TRAVIS_BRANCH" == "master" ] && \ - [ "$TRAVIS_REPO_SLUG" == "MithrilJS/mithril.js" ] - then - # Generate docs - npm run gendocs - - # Set up git env - git config --global user.email "$GH_USER_EMAIL" - git config --global user.name "$GH_USER_NAME" - - # Commit docs to gh-pages branch - # Using --add to ensure that archived versions aren't lost - # Using --repo to force it to go over SSH so the saved keys are used (tschaub/gh-pages#160) - $(npm bin)/gh-pages \ - --dist ./dist \ - --add \ - --repo "git@github.com:MithrilJS/mithril.js.git" \ - --message "Generated docs for commit $TRAVIS_COMMIT [skip ci]" - else - echo "Not submitting documentation updates" - fi +# Disable per https://github.com/MithrilJS/mithril.js/issues/2417 +# after_success: +# - | +# # Set up SSH environment +# $(npm bin)/set-up-ssh \ +# --key "$encrypted_016049456622_key" \ +# --iv "$encrypted_016049456622_iv" \ +# --path-encrypted-key "./.deploy.enc" +# +# # Commit bundle changes generated in before_script step +# # --commands is a weird no-op but required for commit-changes to run +# # --branch arg is to ensure this only runs against the `next` branch +# $(npm bin)/commit-changes \ +# --commands "echo committing" \ +# --commit-message "Bundled output for commit $TRAVIS_COMMIT [skip ci]" \ +# --branch "next" +# +# # Only want to commit docs when building pushes on master & +# # this doesn't have the built-in branch protection like commit-changes +# if [ "$TRAVIS_EVENT_TYPE" == "push" ] && \ +# [ "$TRAVIS_BRANCH" == "master" ] && \ +# [ "$TRAVIS_REPO_SLUG" == "MithrilJS/mithril.js" ] +# then +# # Generate docs +# npm run gendocs +# +# # Set up git env +# git config --global user.email "$GH_USER_EMAIL" +# git config --global user.name "$GH_USER_NAME" +# +# # Commit docs to gh-pages branch +# # Using --add to ensure that archived versions aren't lost +# # Using --repo to force it to go over SSH so the saved keys are used (tschaub/gh-pages#160) +# $(npm bin)/gh-pages \ +# --dist ./dist \ +# --add \ +# --repo "git@github.com:MithrilJS/mithril.js.git" \ +# --message "Generated docs for commit $TRAVIS_COMMIT [skip ci]" +# else +# echo "Not submitting documentation updates" +# fi # Environment configuration env: diff --git a/docs/index.md b/docs/index.md index d1a98478..f795464a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,9 +56,9 @@ An easy way to try out Mithril is to include it from a CDN and follow this tutor Let's create an HTML file to follow along: -```markup +```html - + +```html + ``` --- @@ -18,7 +18,7 @@ If you're new to JavaScript or just want a very simple setup to get your feet we ### NPM ```bash -$ npm install mithril@next --save +$ npm install mithril --save ``` TypeScript type definitions are available from DefinitelyTyped. They can be installed with: @@ -46,7 +46,7 @@ $ npm init --yes 2. install required tools ```bash -$ npm install mithril@next --save +$ npm install mithril --save $ npm install webpack webpack-cli --save-dev ``` @@ -97,7 +97,7 @@ npm init --yes Then, to install Mithril, run: ```bash -npm install mithril@next --save +npm install mithril --save ``` This will create a folder called `node_modules`, and a `mithril` folder inside of it. It will also add an entry under `dependencies` in the `package.json` file @@ -148,7 +148,7 @@ npm start Now that you have created a bundle, you can then reference the `bin/app.js` file from an HTML file: -```markup +```html Hello world @@ -220,7 +220,7 @@ Live reload is a feature where code changes automatically trigger the page to re ```bash # 1) install -npm install mithril@next --save +npm install mithril --save npm install budo -g # 2) add this line into the scripts section in package.json @@ -255,13 +255,13 @@ If you want to try it and give feedback, you can open `package.json` and change If you don't have the ability to run a bundler script due to company security policies, there's an options to not use a module system at all: -```markup +```html Hello world - + diff --git a/docs/simple-application.md b/docs/simple-application.md index 04c6727f..79bdc735 100644 --- a/docs/simple-application.md +++ b/docs/simple-application.md @@ -6,7 +6,7 @@ Let's develop a simple application that shows off how to do most of the major th First let's create an entry point for the application. Create a file `index.html`: -```markup +```html @@ -217,7 +217,7 @@ The `m.mount` call renders the specified component (`UserList`) into a DOM eleme Right now, the list looks rather plain because we have not defined any styles. So let's add a few of them. Let's first create a file called `styles.css` and include it in the `index.html` file: -```markup +```html diff --git a/docs/stream.md b/docs/stream.md index d4f77684..c53f184f 100644 --- a/docs/stream.md +++ b/docs/stream.md @@ -45,8 +45,8 @@ var Stream = require("mithril/stream") You can also download the module directly if your environment does not support a bundling toolchain: -```markup - +```html + ``` When loaded directly with a `