archive-gh-me/documentation
1
0
Fork 0
mirror of https://github.com/documentationjs/documentation.git synced 2026-01-25 14:26:29 +00:00
Code Issues Projects Releases Wiki Activity
632 Commits 17 Branches 116 Tags
Commit Graph

41 Commits

Author SHA1 Message Date
Ans
dd0aca93e6 Prevent double call to require when theme is set + jsdoc fixes (#411) 
- Updates html.js to not double call require when theme is set.
- Normalizes jsdoc comments.
 2016-05-02 13:16:34 -04:00
Tom MacWright
3da1ff6dd0 Source-sorting by default (#410) 
* Source-sorting by default

Many changes

* Uses a new version of module-deps that exposes a sort key
  we use to sort documentation.
* Adds inference for methods in objects
* Groups events into a separate comment property

* Add jsdoc property. Refs https://github.com/documentationjs/documentation/pull/388#issuecomment-215791547

* Namespaces and paths

* More powerful paths: paths now include name, kind, and scope
* comments now include a 'namespace' property with a formatted namespace

* Fix tests

* Re-ignore fonts

* Nix sourceKey from output

* Pin dependency versions

* Fix module-deps-sortable ref

* Update tests for right deps
 2016-04-29 18:09:52 -04:00
John Firebaugh
08d6dc21bd Replace markdown strings with parsed ASTs 
This eliminates the need for formatInlineTags and jsdoc-inline-lex, and simplifies the implementation of HTML themes.
 2016-03-28 13:19:30 -07:00
Tom MacWright
5b3a9d30dc Dependency update (except for remote-origin-url which breaks when you update, update changelog 2016-03-19 17:31:07 -04:00
Tom MacWright
1a1b80aca2 Add support for throws tag to markdown. 
Fixes #360
 2016-03-19 16:20:30 -04:00
Tom MacWright
b465902fa2 Add support for example captions 
Fixes #110
 2016-02-14 18:41:36 -05:00
Tom MacWright
a15e1c5fe2 Update for new highlight.js 2016-01-24 11:26:05 -05: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
Anton Lavrenov
cddc09d996 fix empty example error. add lint rule. 2016-01-15 11:31:59 +08:00
Tom MacWright
bb9fc5f8e5 Infer augments tag from extends keyword. Fixes #195 2015-12-07 18:17:05 -05:00
Tom MacWright
931f48eefc Implement five tags: 
- version
- author
- license
- copyright
- since

These are flattened and output in Markdown. HTML output will
require an update in the theme module
 2015-12-07 17:53:00 -05:00
Tom MacWright
8e0f960db0 Move type formatting helper to utils package 2015-12-07 16:26:14 -05:00
John Firebaugh
0a1de4f343 Theme API 2.0 2015-12-07 16:09:24 -05:00
Tom MacWright
73d6118e1c Implement all doctrine-emitted types. Fixes #249 2015-12-07 12:44:15 -05:00
Tom MacWright
bcc4b2c6b2 Enforce semi: 2 2015-12-06 18:01:55 -05:00
Tom MacWright
8fd36f986a Fix and cover bug in walk, make highlighting functional 2015-11-25 14:19:55 -05:00
Iilei
ebcee3ae07 Pass though hljs options: Enable hljs highlightAuto and languages 
By providing a hljs object within the configuration, `@example` tags in
a variety of languages are parsed properly.
 2015-11-25 17:31:58 +01:00
Tom MacWright
463bb4e62f Improve test coverage 2015-11-09 13:08:56 -05:00
Tom MacWright
eed48f7840 Support github links in markdown output 2015-11-09 12:04:52 -05:00
Tom MacWright
70cc7d0718 Infer Flow type aliases into typedefs. Fixes #227 
Given the `type` tag introduced with Flow, this can infer
a typedef statement, as well as infer its potentially
nested properties and their types.

This also includes

* Refactor of Markdown AST generation that fixes #228
* Refactor of nest.js to handle multi-level nesting
 2015-11-04 11:25:32 -05:00
Tom MacWright
b53f94766e Nest both properties and params. Fixes #164 2015-11-03 11:59:17 -05:00
Tom MacWright
51d4478ac2 Refactor Markdown AST representation. Fixes #216 2015-11-03 10:50:18 -05:00
Tom MacWright
e17b481f03 Use Boolean trick for Markdown AST as well 2015-10-31 20:51:29 -04:00
Tom MacWright
5c62d23d4f Simplify, remove extend 2015-10-31 11:02:14 -04:00
Ilya Radchenko
127082327d Fix default theme resolve 2015-10-30 22:56:14 -04:00
Tom MacWright
ac5b04183f Improve internal documentation, upgrade theme-default. Refs #115 2015-10-30 15:44:46 -04:00
Tom MacWright
7ee83b655f Fix default formatting 2015-10-30 13:44:03 -04:00
John Firebaugh
e67b5d2f55 Use walk where appropriate 2015-10-13 16:15:44 -07:00
John Firebaugh
9822f75b47 Fix output documentation 2015-10-12 11:08:25 -07:00
Tom MacWright
171b7d707a Improve internal documentation 2015-10-11 16:16:43 -04:00
Tom MacWright
2ea79c0870 Combine highlight and html. Fixes #173 2015-10-11 16:06:21 -04:00
Tom MacWright
b3c990db1f Simpler and stricter eslint 2015-10-06 20:31:50 -04:00
Tom MacWright
a65801a6d4 Add and test default parameter parsing. 
cc @killercup this implements default parameter parsing for both
flow-annotated and unannotated methods
 2015-10-06 15:51:46 -04:00
Tom MacWright
b173cf14a5 Fix parameter sorting, nest properties in Markdown 2015-10-05 15:02:33 -04:00
Tom MacWright
01b34dee06 Add markdown_ast raw AST output mode 2015-10-03 16:57:37 -04:00
Tom MacWright
f0954859f6 mdast-powered Markdown output 2015-10-03 16:57:37 -04:00
Tom MacWright
74b9bd4e0e Fix tests for new error strategy 2015-10-01 20:41:50 -04:00
Tom MacWright
de9ff078a6 Remove straggling mentions of streams 2015-09-28 20:40:44 -04:00
Tom MacWright
c24a9b88a4 Enable jsdoc rule and enforce it. 
Also:

* Moves reduction out of parsers so that they don't have awkward
  function signatures
 2015-09-28 20:36:07 -04:00
Tom MacWright
a383a045e2 Fix tests 2015-09-27 12:46:09 -04:00
Tom MacWright
abf5100095 Rewrite more tests 2015-09-27 10:36:30 -04:00