documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Sort order of types in the README injection

Open jmakeig opened this issue 9 years ago • 1 comments

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,

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

orders as expected given .docs.json

{
  "toc": [ … ]
}

However,

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

jmakeig avatar Nov 23 '16 08:11 jmakeig

Sort was ok for me, builder following order in source code until I added shallow option.

After that order has been broken and sort doesn't work in markdown for me neither. I tried adding an array like ['Intro', 'Resources', 'Demo'] and the object given by @jmakeig - none of these helped.

Strangely enough, even alphanumeric order is not working, as actual output is Resources, Intro, Demo.

kalinchernev avatar Nov 27 '18 07:11 kalinchernev