76 Commits

Author SHA1 Message Date
Tom MacWright
6bf515e936 Add FAQ entry to lock down understanding around #413 2016-06-17 15:57:46 -04:00
Tom MacWright
c33fe6b904 Add usage doc for node usage 2016-06-12 17:14:46 -04:00
Erik Arvidsson
629ea6f3a8 Add support for inferring private based on the name
This adds a command line flag called `--infer-private` which is a
string (defaults to `^_`) which is used as a regexp for inferring
if a name is private or not.

For example:

```js
/** C */
class C {
  /** I'm public */
  m() {}
  /** I'm private */
  _p() {}
}
```

Fixes #436
2016-06-01 14:40:08 -07:00
Tom MacWright
11f13df60f Add troubleshooting. Fixes #428. Fixes #401 2016-05-26 14:08:12 -04:00
Tom MacWright
0727ef8f55 Document sorting/configuration system. Fixes #100. Fixes #14 2016-05-26 14:03:31 -04:00
Andreas Hocevar
6e352a1049 Add commands, update options and fix example 2016-03-09 14:25:19 +01:00
Titus Wormer
35e17be4e4 Rename mdast to remark
Note that the AST now carries the name “mdast”, meaning
utilities (such as mdast-util-inject) keep their name.

This name-change includes the `mdast` formatter, which also changed
to `remark`.

Additionally:

* Update relating packages.
* Fix a bug where `text` nodes without value were
  [generated](6b905aefb1/lib/output/markdown_ast.js (L144)).
2016-01-24 10:35:51 -05:00
Denis
1508412ae8 Add the missed comma in GETTING_STARTED.md
Fix #307
2015-12-11 19:35:46 +03:00
Tom MacWright
e99f64ca5c Update GETTING_STARTED.md 2015-12-10 18:30:46 -05:00
Tom MacWright
68aa236ef9 Move see also to https://github.com/documentationjs/documentation/wiki/See-also 2015-12-10 18:25:54 -05:00
Vladimir Grinenko
238d4f3b2e Fix typo 2015-12-10 11:42:22 +03:00
John Firebaugh
0a1de4f343 Theme API 2.0 2015-12-07 16:09:24 -05:00
Tom MacWright
ea8d47f19f Merge branch 'master' of github.com:documentationjs/documentation 2015-12-06 19:54:56 -05:00
Tom MacWright
b3ac22430b Test and document behavior around documenting destructured params. 2015-12-06 19:47:36 -05:00
Karl Horky
01730ef78d Add Flow section to getting started 2015-12-05 12:42:32 +01: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
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
f0954859f6 mdast-powered Markdown output 2015-10-03 16:57:37 -04:00
Tom MacWright
a88ad7f661 Update SEE_ALSO.md 2015-10-03 11:05:30 -04:00
Seth Vincent
aa17e1d766 Fix GETTING_STARTED.md filename 2015-07-19 13:48:27 -07:00
Tom MacWright
f4ad3e9c93 Add theming doc 2015-07-10 16:50:40 -04:00
Tom MacWright
3ee808ce8c Update markdown theme docs 2015-07-10 15:08:07 -04:00
Tom MacWright
903fdb1290 Add HTML theme documentation 2015-07-10 14:07:01 -04:00
Tom MacWright
9a03c7fb0e Start to refactor and document helpers for templates 2015-07-10 12:03:39 -04:00
Tom MacWright
017c6c5aa2 Add streams to eslint coverage, organize docs 2015-07-10 10:56:45 -04:00