90 Commits

Author SHA1 Message Date
Christian Oliff
58ae594cc8
Fix typos found with cSpell (#1621)
Fix typos found wtih cSpell
2024-01-31 12:20:00 -05:00
Momtchil Momtchev
e030a3f776
Sort memberof (#1452)
* correctly sort undefined values

* the new sort order is the correct one

* support sorting by memberof

* support sorting by memberof

---------

Co-authored-by: Tom MacWright <tmcw@users.noreply.github.com>
2024-01-30 13:40:11 -05:00
Oliver Schmidt
930edd2ba3
Update USAGE.md (#1463) 2024-01-30 13:39:32 -05:00
Christian Fritz
12cfa02ee3
Update NODE_API.md (#1616)
- fix order -> sortOrder
- added example
2024-01-30 13:38:19 -05:00
Saad Hasan
4fec3f4580
Added Another Use full example with Screenshot (#1557) 2022-12-14 10:10:07 +01:00
Momtchil Momtchev
4225844a04 support additional sorting orders 2021-11-16 15:29:24 +03: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 Shchekota
e3c59d77e4 fix: external was removed as prefer of input usages
BREAKING CHANGE:
external parameter was removed
Migration plan propose to move all external resources to input usages
Motivation: packages has many inputs which describe in package.json
so that mean need each time to parse all package.json of exsternal resources to understand which etry point need to pick.
But it is base on guesses because entry point may could not contains a documentation and the best way to handle it manualy.
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
Justin Gosses
6f01ad2536
docs: added content about an alternative way to establish style. (#1356)
Added content about an alternative way to establish style.
2021-02-15 11:19:36 -08:00
Nilesh Arnaiya
761aaee419
Update GETTING_STARTED.md (#1294)
* Update GETTING_STARTED.md

* Update GETTING_STARTED.md

* Update GETTING_STARTED.md

Co-authored-by: Tom MacWright <tmcw@users.noreply.github.com>
2020-03-16 21:16:56 -07:00
Christian Oliff
7b82bcded9
update jsdoc.app URL in GETTING_STARTED.md (#1304) 2020-03-16 20:59:17 -07:00
Christian Oliff
36da108c2f
HTTPS link to daringfireball.net/projects/markdown/ (#1297) 2020-03-16 20:59:05 -07:00
Zearin
d0f7eeb783 docs: Minor tweaks to formatting and phrasing. (#1303) 2020-02-09 11:15:00 -08:00
Christian Oliff
c1e4dbe923 Update RECIPES.md (#1291)
Fix links to HTTPS to prevent redirects
Fix hierachical typo
2019-10-14 08:56:41 -07:00
Christian Oliff
3ecc358e58 HTTPS link to https://eslint.org/docs/rules/valid-jsdoc.html (#1287) 2019-10-10 11:26:38 -07:00
Christian Oliff
7d12421336 docs: HTTPS link to remark.js.org (#1251) 2019-06-06 09:44:40 -07:00
Christian Oliff
f0ed12e84f docs: fix a couple of URLs to prevent redirects (#1249) 2019-06-06 08:44:10 -07:00
Christian Oliff
e8734dd56d docs: Update URLs to prevent redirects (#1244) 2019-05-23 08:29:15 -07:00
yhor1e
03e721f95e docs: Fix THEMING.md line number (#1223) 2019-03-16 15:57:15 -07:00
Harry
70081238fb docsL Added promises to "recipes" documentation (#1220)
* Added promises to recipes docs

* Syntax correction
2019-03-16 10:47:37 -07:00
Yicheng (Jerry) Gong
15bbc063da Adding additional cli option, markdown-toc-max-depth for configuring markdown-toc maxDepth (#1215) 2019-03-12 11:42:43 -07:00
Jonas Bögle
5b045f26c0 feat: Add favicon option (#1207) 2019-02-22 08:11:26 -08:00
Tom MacWright
631e90d983
Remove plugin FAQ for now. 2018-12-01 12:47:21 -08:00
Ryan James
e295c73e5a s/compacter/'more compact'/ in GETTING_STARTED
'compacter' isn't a word. 🙃
2018-11-20 14:27:13 -08:00
Max Schmitt
45a9ea924a feat: added project description 2018-08-03 15:35:25 -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
Taylor Ackley
43682b20f8 docs: Update THEMING.MD (#1026)
* Docs: Update THEMING.MD

Add instructions to effectively fork the default theme for the purpose of creating and using your own custom theme.

* Docs: Revise THEMING.MD per Pull Request Feedback

Chanted the script line example to use documentation instead of referring to the node_modules bin folder.
2018-03-01 09:07:23 -08:00
Jonas Bögle
f0c32278a8 docs(readme, usage): updated help command/message (#994) 2018-01-12 16:00:23 -08:00
Thomas Broadley
4bb2047064 Fix typos (#977) 2017-12-15 20:06:14 -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
Victor Glindås
c43701b672 docs: Fix grammar in getting started
Grammar fix.
2017-10-05 09:30:04 -07:00
Ryan Hendrickson
c94412a7aa feat: groups in toc (#895) 2017-09-03 23:44:31 -07: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
Prateek Saxena
5b5dcd1662 docs(theming): fix default theme link 2017-07-20 12:05:28 -04:00
Dan Dascalescu
32ef5a5fec docs: Don't end 'getting started' abruptly, instead link to next steps.
Fixes #826
2017-06-25 12:04:09 -04:00
Tom MacWright
4ba0a822a2 docs(api): Update API docs (#784) 2017-05-12 09:57:34 -04:00
Julien Vanier
c055aecee8 docs: Provide syntax for specifying configuration (#778) 2017-05-11 10:33:29 -04:00
Julien Vanier
5b6b3bb8cd docs: Update recipe for documenting destructuring parameters 2017-05-05 16:57:27 -04:00
Tom Macwright
2c19809f07 docs(lends): Document the usage of the lends tag
This tag is useful for documenting class factories in libraries and frameworks

Refs #412
2017-04-25 11:12:38 -04:00
Tom Macwright
355038d03e fix: Infer parameters for classes from constructors
Fixes #689
2017-04-24 19:16:34 -04:00
John Kerssens
72e04b885c chore(docs): fixing spelling 2017-03-26 15:16:59 -04:00
Dano Alexander
98f86d70ea Fix typo (#656) 2017-01-12 10:17:41 -05:00
Tom MacWright
2cf84297f9 docs(markdown): Document approaches to Markdown theming (#647)
Fixes https://github.com/documentationjs/documentation/issues/550
2016-12-29 16:32:57 -05: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