documentationjs / documentationjs/documentation

Sort order of types in the README injection

Open
#615 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

I’m able to control the sort order of the types when I build HTML docs. However, I can't figure out how to specify the same order for the `readme` command.

For example,

```shell
documentation build *.js --config .docs.json --format html --output docs/
```

orders as expected given `.docs.json`

```json
{
"toc": [ … ]
}
```

However,

```shell
documentation readme *.js --config .docs.json --section Usage
```

does not seem to use the `--config` parameter. (Although, it also doesn’t complain about its existence.)

documentation: 4.0.0-beta14
node: v6.5.0
npm: 3.10.3
macOS: 10.11.6

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.