documentationjs / documentationjs/documentation

readme markdown injection does not include the table of contents

Open
#935 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

I have `documentation.js@5.3.2` installed as a dev-dependency and am using it with an npm script configured as follows

> `documentation readme -s Documentation src/**`

Previously I was doing:

> `documentation build src/** -f md -o docs.md`

The README injection works like a charm. But I was a bit disappointed that I no longer get a table of contents. I'm not sure if I'm missing some relevant option, but if not, it would be awesome if this feature were supported.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.