- 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
* 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
* 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.
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
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.
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
This brings logic from eslint over to documentation: instead of readdirSync, we're using the glob
module. This also, I hope, will let us support globs on Windows without changing OSX/Linux behavior.
Fixes#607
crucial since home page links to GETTING_STARTED.md, without first showing any installation instructions -- those are currently only found in the README.md / GH repo landing page.
Valid values for the `--sort-order` flag are `"source"` (default) and
`"alpha"`. When set to `"alpa"` the order of the entries in the docs
are sorted alphabetically.
Fixes#534
* Add a flag to document all exported bindings
This adds a boolean flag called `document-exported` (defaults to false)
that effectively adds an empty comment to all exported bindings that do
not already have a JSDoc comment. It also does the same for the
members of exported classes and objects.
```js
export class C {
method() {}
}
```
Both `C` and `C#method` are now part of the generated documentation.
Related to #424
* Fix lint error
* Rebase and use options pragma in test file
* Create extractor type as a generalized comment/export getter
* Document exported extractor
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
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)).
