21 Commits

Author SHA1 Message Date
Christian Fritz
12cfa02ee3
Update NODE_API.md (#1616)
- fix order -> sortOrder
- added example
2024-01-30 13:38:19 -05:00
Anton Shchekota
abb781a69a refactor: replace module-deps-sortable on own implementation to control how parse files
BREAKING CHANGE:
all Extensions whould contains '.' so that mean if you have just 'ts' then need to convert to '.ts'
2021-11-11 11:52:31 +03:00
Anton
09a441ac42
refactor: Remove plugin-proposal because it is related of transform code (#1371)
* deps: Remove plugin-proposal because it is related of transform code

1. Documentation need to just parse code and do not transform anything.
That why need to remove plugin and preset usages
2. Remove parser options which already included in parser and enabled by default

* chore: Update docs related remark 13
2021-04-20 13:41:30 -07:00
Anton Shchekota
3babb4a0f4 deps: udpate remark and remove babel-eslint parser 2021-04-15 16:17:34 +03:00
Christian Oliff
36da108c2f
HTTPS link to daringfireball.net/projects/markdown/ (#1297) 2020-03-16 20:59:05 -07:00
Jayden Seric
ca6217fb19 feat: Semantic markdown headings (#1087)
- Previously, headers were displayed using `p` and `strong` tags. This is semantically incorrect, and would cause subheadings to display larger than headings for nested sections on platforms such as Github.
- “Parameters”, “Properties”, and “Examples” now render as headings with a dynamic level greater than the heading they are nested under.

BREAKING CHANGE: changes Markdown output
2018-06-04 11:51:09 -07:00
Tom MacWright
ab494dd1b3
feat: use reference links for Markdown output, improving brevity
* Use reference links in Markdown.

Fixes https://github.com/documentationjs/documentation/issues/948.

This approach might be problematic when inserting markdown under a readme heading if the readme already has link references with conflicting ID’s.

* Reference links edits:

- fix broken normalize() utility in test suite so that it produces
  output that doesn't choke referenceLinks.
- add DocumentationConfig option `--noReferenceLinks` which will be
  **internal only**, and turns off reference links for `readme` mode
- rebuilds test output with these changes

unrelated but minor

- includes .prettierrc and updates calls to prettier to use that instead
  of CLI options

* chore: update test snapshots

* Update readme snap
2018-03-01 15:18:20 -08:00
Tom MacWright
aa661ffcbf
fix(globals-docs): Remove en-US from MDN links. (#973)
This allows the Mozilla Developer Network to infer the user language.

Fix #964
2017-12-11 17:04:28 -08:00
Tom MacWright
e0b605f817 style: Avoid optional parameter syntax
Supporting this syntax uncorks a whole bottle of worms and requires participation in more of the
JavaScript ecosystem and is not worthwhile in my opinion at this time.

Fixes #873
2017-08-12 14:25:34 -07:00
Anton
0324865ad5 fix: make html and markdown second option optional (#871)
Fixed #869
2017-08-09 10:25:32 -07:00
Tom MacWright
5b373ff2fe revert(polyglot): Remove polyglot mode
BREAKING CHANGE: I'd like to still support C++ and other languages in the future! But I'm much
happier doing so by separating the extraction & input phases to the degree that documentation.js can
read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
support in it.

Fixes #850. Fixes #731. Fixes #702. Fixes #132.
2017-07-27 13:58:49 -04:00
Tom MacWright
4ba0a822a2 docs(api): Update API docs (#784) 2017-05-12 09:57:34 -04:00
Tom MacWright
4c66fb14c7 feat(markdown): Add table of contents support for Markdown mode (#645)
Adds a new option, `--no-markdown-toc`, to turn off Table of Contents generation. Table of contents are now generated by default with markdown output, including through the `readme` command.

Fixes https://github.com/documentationjs/documentation/issues/220
2016-12-28 21:12:33 -05:00
Tom MacWright
2ae5d8f304 fix(markdown): Start headings in Markdown at h2 (#644)
Fixes https://github.com/documentationjs/documentation/issues/641
2016-12-28 20:12:17 -05:00
Tom MacWright
813dfbbc29 docs(nodeapi): Fix node API documentation: formatters call (err, res) (#643)
Fixes https://github.com/documentationjs/documentation/issues/642
2016-12-28 18:16:08 -05:00
Tom MacWright
fc58bebaef Document new inferPrivate and extension options 2016-11-11 11:31:52 -05:00
Tom MacWright
f926b3da23 Add lint example 2016-11-11 11:24:05 -05:00
Tom MacWright
375e8007b2 Update Node API to include only exposed API surface 2016-11-11 11:22:07 -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
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
3b2e6faff8 Inter-link documentation better 2015-10-30 16:11:41 -04:00