49 Commits

Author SHA1 Message Date
Tom MacWright
ccd56b61e7 ci(coveralls): Remove coveralls 2018-12-17 10:29:18 -08:00
Tom MacWright
6e74050a12 doc: Fix CLI examples 2018-12-10 09:04:01 -08:00
Tom MacWright
f66dd11e05
doc: remove Greenkeeper 2018-12-10 09:02:42 -08:00
Christian Oliff
d04a5555cb URL updates for README (#1193) 2018-12-06 08:11:38 -08:00
Tom MacWright
ecf99f8d83
Update README.md 2018-10-21 13:31:54 -07:00
Tom MacWright
f60d90cf9e
feat: Vue Support
Thanks to @batje, documentation.js now supports Vue! .vue files are parsed for their JavaScript contents by default.
2018-04-20 11:45:14 -07:00
Karna
5236ddf3a0 docs: Improve README
* Update to README.md

Few changes of corrections and fixes here and there!

* Updated

Changes requested accordingly, my apologies.

* Update README.md

Amended
2018-02-14 16:06:59 -08:00
Jonas Bögle
f0c32278a8 docs(readme, usage): updated help command/message (#994) 2018-01-12 16:00:23 -08:00
Tom MacWright
d7fb94e075 docs(readme): Improve README: add new logo, simplify (#714)
Also moves the GreenKeeper badge to the correct line
2017-04-10 17:23:16 -04:00
greenkeeper[bot]
cf2ef2bc50 Update dependencies to enable Greenkeeper 🌴 (#711)
* chore(package): update dependencies

https://greenkeeper.io/

* docs(readme): add Greenkeeper badge 

https://greenkeeper.io/

* chore(greenkeeper): Exclude remote-origin-url and yargs from Greenkeeper for now
2017-04-10 16:19:11 -04:00
Andrei Mihailov
d053391b5e Update README.md (#695)
Fixes #693
2017-03-16 09:57:43 -04:00
Glenn Reyes
a92b9ff28e Switch to shield style CircleCI badge (#692) 2017-03-11 14:55:11 -05:00
Tom MacWright
631c6925d4 feat(core): Switch to Promises everywhere. Adopt Node v4 ES6 (#648)
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6

Big changes:

* Uses template strings where appropriate
* Config and argument parsing is unified and there is no such thing
  as formatterOptions anymore. All user-passed options go through
  mergeConfig.
* The node API surface changed (again): `buildSync` is removed,
  building operations return Promises.
* Now using Flow for internal type annotations.

More changes:

* Remove buildSync command
* feat(inference): Partially implement object shorthand support
* Refs #649
* Use Flow annotations to  enforce types
* Keep flow but switch to comment syntax
* Clarify types
* More flow improvements
* Turn server into class
* LinkerStack becomes class too
* Fix comment description type
* Run flow on lint
* Many more flow fixes
* More intense flow refactoring
* Simplify inference steps
* Update inference tests, flow errors down to 1
* Continue refining types
* Fix more flow issues
* Use 'use strict' everywhere
* Make 'ast' property configurable
* Fix many tests
* Fix more tests
* Fix more tests
* Fix augments
* Test Markdown meta support
* Improve test coverage
* Switch back from for of to for for speed
2017-01-27 16:14:19 -05:00
Tom MacWright
3b26b9c169 ci(coverage): Switch back to coveralls for code coverage (#639)
node-tap removed built-in codecov support, so back to coveralls we go

Fixes https://github.com/documentationjs/documentation/issues/638
2016-12-26 11:08:07 -05:00
Tom MacWright
381ef48b9f docs(readme): Add new usage examples to README
https://github.com/documentationjs/documentation/pull/588
2016-12-01 14:12:06 -05:00
Oier Izulain
f0e55e1495 Fix example links in README 2016-06-06 15:08:35 +02:00
Tom MacWright
1570955520 Improve internal documentation 2016-06-01 17:17:03 -04:00
Tom MacWright
11f13df60f Add troubleshooting. Fixes #428. Fixes #401 2016-05-26 14:08:12 -04:00
Tom MacWright
b70344c332 Fixes #426 2016-05-16 12:56:09 -04:00
Tom MacWright
d1c4101db3 Test only in node v5 for speed 2015-12-14 10:22:39 -05:00
ikokostya
a24eac0d5d Fix "See also" link 2015-12-11 21:05:06 +03:00
Tom MacWright
f98bfa98ca No need for a _ here 2015-12-10 18:19:56 -05:00
Andrew Kiellor
312d3957fe Add david badge for dependency freshness. 2015-12-09 21:02:03 -08:00
John Firebaugh
0a1de4f343 Theme API 2.0 2015-12-07 16:09:24 -05:00
Tom MacWright
d069b6a40b Support new node versions, including v4 and v5
* Compare strings as lowercase, to permit for v4+ compatibility
* Fix bad reference to loc.name
* Update README badge and fixture
* Remove brfs dependency
* Remove traverse
* Remove browser transform support
2015-12-01 15:34:50 -05:00
Tom MacWright
88bc96d71a s/esprima/babel, discuss inference 2015-11-03 18:15:44 -05:00
Tom MacWright
fb9fcfb2d3 Update -h examples, fix reference to streams 2015-10-30 17:57:39 -04:00
Tom MacWright
3b2e6faff8 Inter-link documentation better 2015-10-30 16:11:41 -04:00
Tom MacWright
85ff395bab Add gitter badge 2015-10-19 09:03:43 -04:00
John Firebaugh
43b2571ae2 Update usage (fixes #138) 2015-08-30 17:02:22 -07:00
Tom MacWright
e737e7105c Mention polyglot in readme 2015-07-10 11:16:28 -04:00
Tom MacWright
a36028a6c6 Reorganize readme 2015-07-10 11:10:09 -04:00
Tom MacWright
bfc32d056d Add version badge 2015-07-06 09:51:20 -04:00
Tom MacWright
932ae33789 Remove docset mention from readme 2015-06-25 11:43:31 -04:00
Tom MacWright
bd1c844565 Update dependencies, add coveralls badge. 2015-06-25 11:42:42 -04:00
Tom MacWright
8883fa371b Remove docset and its sqlite dependency
Remove other dependencies only used by docset

Remove docset support from README. Fixes #61
2015-06-16 14:09:12 -04:00
Tom MacWright
f7bdb94980 Fix doc example 2015-04-10 11:24:28 -07:00
Tom MacWright
5aa0c611d0 Shoutout gulp 2015-04-09 17:52:41 -07:00
Tom MacWright
4bcdbaa3a5 Link JSDoc a little more 2015-04-08 19:26:46 -07:00
Tom MacWright
d9957229a1 Add usage docs 2015-04-08 19:25:32 -07:00
Tom MacWright
6c10bb767d Add dash to readme 2015-04-08 18:48:07 -07:00
Tom MacWright
53377d4279 Note github integration 2015-04-08 15:41:20 -07:00
Tom MacWright
9650985ef5 Fold GOALS into README 2015-03-26 16:05:40 -04:00
John Firebaugh
c7e2793352 Use CircleCI instead 2015-03-11 15:22:55 -07:00
Tom MacWright
e293050817 Add travis badge and hook 2015-03-11 14:25:02 -04:00
Tom MacWright
fb5afc4428 Add mission 2015-03-11 11:04:02 -04:00
Tom MacWright
430c194360 Update readme 2015-03-10 19:45:41 -04:00
Tom MacWright
2275226ac0 Readme & contrib 2015-03-10 19:22:17 -04:00
Tom MacWright
14e03d175f First 2015-03-09 23:34:01 -04:00