Commit graph

56 commits

Author SHA1 Message Date
Arthur Clemens
5f9c635cad Remove old TOC link
Content was moved some time ago and linked section no longer exists.
2021-08-17 22:34:07 -04:00
Miguel Espinoza
ff3e12e5d3
Update installation.md (#2608) [skip ci]
Co-authored-by: Isiah Meadows <contact@isiahmeadows.com>
2020-07-12 13:26:56 -07:00
Pierre-Yves Gérardy
4a3a486d80
Pimp the docs linter (and assorted changes) (#2553)
### Pimp the docs linter (and assorted changes)

 #### `scripts/lint-docs.js`

- Add an optional cache for faster runs
- Add a final report
- Don't return anything from `exec()`
- Cover more files

 #### `scripts/_command.js`

- Look for a "--cache" option

 #### `package.json` scripts

- Added `watch:lint-docs`
- Added `cleanup:lint` to remove the eslint and lint-docs cache files
- Changed `lint:docs` to use the `--cache` option
- Added `test:js` so that we can run the test suite without the linter
- Changed `test` to defer to `test:js`

 #### Actual lint fixes:

- Bad link in a migration guide
- The unicode dashes in the "https://en.wikipedia.org/wiki/Subject–verb–object" are not escaped by marked

### Some more lint-docs pimping

#### `scripts/lint-docs.js`

- some code reorg and cleanup (take a hint from the local coding conventions)
- fix misc bugs
- pass a User-Agent header to the requests
- even nicer reporting

#### `package.json`

- bump the @babel/parser dep to the latest

#### Docs

- tweaks based on lints missed due to previous bugs

### Docs: use the github page for velocity.js, the home page has too many errors.

Co-Authored-By: Isiah Meadows <contact@isiahmeadows.com>
2019-12-19 23:40:52 +01:00
Isiah Meadows
48e7fd1711
Refactor scripts (#2465)
* Refactor all kinds of scripts

* Update docs to ensure linter passes
2019-07-27 15:12:49 -04:00
Isiah Meadows
234b1c9302 Update migration, fix various minor issues
- Lot of people couldn't migrate to v1 and plan to reevaluate when v2 is
  released.
- It's "npm" not "NPM". It doesn't stand for anything, and it never
  has - it was initially chosen simply because it was easy to type.
  It has a lot of unofficial backronyms with "Node Package Manager"
  being one of the most common ones, but it's never officially stood
  for anything as an acronym *or* initialism.
- Fixed a few errors in the change log, like non-breaking changes being
  included in the "Breaking Changes" section and an inaccuracy in the
  summary of a particular change.
- Fixed RawGit URLs to point to GitHack, which is a lighter proxy that
  offloads caching to Cloudflare instead of also implementing it itself.
  (It also just uses nginx for all the important server logic, so it
  scales better.)
- Add a few more v0.2 references as appropriate
2019-07-24 05:01:20 -04:00
Isiah Meadows
b580e241c8 Prepare for v2, s/markup/html/g in code blocks 2019-07-23 16:42:54 -04:00
Isiah Meadows
a23bcea7ee
Correct a bunch of incorrect/outdated references (#2457)
- Babel 7 has a whole different module API
- Traceur is basically dead
- JSX != HTML
- Some bits are just obvious from context what they are
- ES6 docs shouldn't be auto-installing JSX support
- Also, I decided it was worth clearing up some misleading docs in
  surrounding areas.
2019-07-06 03:41:01 -04:00
spacejack
696b5cbfe3 Edit types installation to be clearer and easier to find (#2435) 2019-06-20 07:02:02 -04:00
Daniel Loomer
9b38e41fd6 standardize cdn links in docs (#2416)
- consistently use @next and explicit path
2019-05-27 11:58:11 -04:00
Ayush Jain
982fdf5737 Corrected the case issue of 'JavaScript' throughout the docs (#2401)
* corrected JavaScript spelling
2019-04-01 08:14:38 -04:00
Isiah Meadows
b91a10a233
s/mithril/mithril@next/g, add v1 docs link [skip ci] (#2368)
This should help point users to the correct version if they plan to
install the release candidate, and it should help users find the
existing docs for v1.
2019-02-02 11:01:51 -05:00
Travis Horn
86549d3d48 Fix #2210 (#2259)
Changed the example command for Mithril Bundler to be more consistent with Webpack quick start.
2018-10-26 16:42:01 -04:00
Pat Cavit
c335aa70ca
docs: latest site updates (#2126) 2018-04-20 08:36:08 -07:00
Pat Cavit
6fb77b7771
docs: update with latest fixes (#2116) 2018-04-12 00:11:11 -07:00
Pat Cavit
5660637e30 docs: new repo refs and build tweaks 2017-05-02 13:12:00 -07:00
Gheorghe Anghelescu
aaa9c17117 docs: use https in installation docs (#1568) 2017-01-30 13:47:49 -08:00
Leo
431436bd6a prep docs 2017-01-30 10:43:22 -05:00
Leo Horie
7c00aad19c beef up docs and defrag setup flow 2017-01-08 10:53:54 -05:00
Leo Horie
be27f4d525 more documentation tweaks 2017-01-08 08:21:33 -05:00
Leo Horie
33fb63a72b fix merge 2017-01-03 10:47:35 -05:00
Hugo Freitas
ba96c23b84 Remove duplicated install 2017-01-02 17:30:49 -03:00
Leo Horie
c71ebf18ed tweaks in docs 2016-12-31 08:35:50 -05:00
Dmitri Zaitsev
b14ca82c2e Recommend 'budo' for the quickest start ever
Fewer steps to get a complete app running in the browser with live reload.
2016-12-31 03:32:57 +00:00
Leo Horie
8746e397b7 link mentioned tools 2016-12-30 07:54:01 -05:00
Leo Horie
ad920483c6 reference CDN in vanilla section 2016-12-30 07:51:03 -05:00
Leo Horie
dd81bcd639 add more docs about global/local installs 2016-12-30 07:48:55 -05:00
Leo Horie
2b1cd9b8f0 add save flag 2016-12-30 07:45:33 -05:00
Leo Horie
e342640770 recommend webpack as bundling solution 2016-12-30 07:44:12 -05:00
Leo Horie
87dcbbf5c7 small tweaks to docs 2016-12-01 01:49:19 -05:00
Leo Horie
f7c187eec9 improve installation docs 2016-11-24 20:46:49 -05:00
Leo Horie
b8701d0c72 sync 2016-11-22 00:30:21 -05:00
Leo Horie
60df92cfba simplify steps 2016-11-15 10:16:14 -05:00
Pat Cavit
bcb81c4b03 Use tag for npm install
And update example to correct dependency format
2016-11-10 11:05:22 -08:00
Leo Horie
adf91a4f7a update npm identifier 2016-10-31 12:24:46 -04:00
Leo Horie
04ffdae2a3 some more docs 2016-10-26 10:56:36 -04:00
Leo Horie
ca7d1e856b document setup via npm 2016-07-28 22:41:26 -04:00
Leo Horie
13fdb60f66 clean slate 2016-04-20 20:01:04 -04:00
kaspertidemann
a3af03a600 Fixes wording. 2015-12-10 15:51:17 +01:00
Dan Okkels Brendstrup
e9d46d0e06 Download button + links point to Installation page 2015-11-15 20:59:53 +01:00
Jona H.
58d5b306fd fixed bower description
Technically, Bower isn't really a package manager for Node.js, but rather, it's made in Node and built for usage in the frontend, hence why many popular frontend libraries, such as JQuery or Bootstrap have their distributions on there. Bower also has its own package repositories.
2015-06-13 09:47:20 +02:00
Leo Horie
a3cc70863c fix link 2015-05-01 09:30:18 -04:00
Leo Horie
bca33a0b78 fix docs about using bleeding edge from npm 2015-04-15 22:41:15 -04:00
Leo Horie
11c53fd9ee update docs about bleeding edge build via npm 2015-03-30 17:30:31 -04:00
Leo Horie
1dffbf781f improve docs 2014-09-14 00:52:11 -04:00
Leo Horie
d11087e9f6 fix wording 2014-09-03 21:10:50 -04:00
Leo Horie
c736e738ce fixing links 2014-08-12 18:00:54 -04:00
Leo Horie
07c4e0bdd2 update docs for component 2014-07-02 09:31:36 -04:00
David Niergarth
9ea782f759 Copy edit docs 2014-05-26 23:51:16 -05:00
Leo Horie
f589a33842 docs about extract 2014-04-20 20:01:06 -04:00
Leo Horie
7d0ba8401f add docs about github 2014-04-10 22:07:32 -04:00