documentation

mirror of https://github.com/documentationjs/documentation.git synced 2026-01-18 14:17:30 +00:00

History

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

CONFIG.md

feat: groups in toc (#895 )

2017-09-03 23:44:31 -07:00

FAQ.md

Fix typos (#977 )

2017-12-15 20:06:14 -08:00

GETTING_STARTED.md

docs: Fix grammar in getting started

2017-10-05 09:30:04 -07:00

NODE_API.md

feat: use reference links for Markdown output, improving brevity