Introduce doctoc for "Table of Content" generate #1408
Conversation
Will use it to generate "Table of Contents"
README.markdown
Outdated
| - [Installing nvm on Alpine Linux](#installing-nvm-on-alpine-linux) | ||
| - [Problems](#problems) | ||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
There was a problem hiding this comment.
instead of this comment, could we add a travis script that reruns doctoc and fails if it generates a diff?
package.json
Outdated
| @@ -13,7 +13,8 @@ | |||
| "test/installation": "npm run --silent test/installation/node && npm run --silent test/installation/iojs", | |||
| "test/installation/node": "shell=$(basename -- $(ps -o comm= $(ps -o ppid= -p $PPID)) | sed 's/^-//'); make TEST_SUITE=installation_node test-$shell", | |||
| "test/installation/iojs": "shell=$(basename -- $(ps -o comm= $(ps -o ppid= -p $PPID)) | sed 's/^-//'); make TEST_SUITE=installation_iojs test-$shell", | |||
| "test/sourcing": "shell=$(basename -- $(ps -o comm= $(ps -o ppid= -p $PPID)) | sed 's/^-//'); make TEST_SUITE=sourcing test-$shell" | |||
| "test/sourcing": "shell=$(basename -- $(ps -o comm= $(ps -o ppid= -p $PPID)) | sed 's/^-//'); make TEST_SUITE=sourcing test-$shell", | |||
| "doctoc": "doctoc README.markdown" | |||
There was a problem hiding this comment.
let's please add --title='## Table of Contents' which should reduce diffs (also --github, to be explicit)
README.markdown
Outdated
| - [Listing versions](#listing-versions) | ||
| - [.nvmrc](#nvmrc) | ||
| - [Deeper Shell Integration](#deeper-shell-integration) | ||
| - [Zsh](#zsh) |
There was a problem hiding this comment.
The "Z" in zsh shouldn't be capitalized here - can we update the corresponding section name so that both are always lowercase?
PeterDaveHello
force-pushed
the
doctoc
branch
from
5c5755b
to
f8aaa32
Compare
|
Updated! Thanks @ljharb |
PeterDaveHello
force-pushed
the
doctoc
branch
from
57e57ea
to
8f4b60d
Compare
|
@ljharb test added, please take a look, thanks. |
.travis.yml
Outdated
| @@ -11,8 +11,10 @@ addons: | |||
| - ghc | |||
| - zsh | |||
| - ksh | |||
| - nodejs | |||
There was a problem hiding this comment.
um, why would we need travis to install node from apt? it already has it from nvm. can't the script run nvm install node?
There was a problem hiding this comment.
Updated, please help me terminated the earlier builds on Travis CI if possible, thanks.
PeterDaveHello
force-pushed
the
doctoc
branch
2 times, most recently
from
5cf96fe
to
aa92e76
Compare
| @@ -13,6 +13,7 @@ addons: | |||
| - ksh | |||
| cache: | |||
| directories: | |||
| - $HOME/.npm | |||
There was a problem hiding this comment.
this line is no longer needed, right?
There was a problem hiding this comment.
I think we can still keep it to speed up npm install doctoc
.travis.yml
Outdated
| - if [ -n "${SHELLCHECK-}" ]; then shellcheck -s bash nvm.sh && shellcheck -s sh nvm.sh && shellcheck -s dash nvm.sh && shellcheck -s ksh nvm.sh ; fi | ||
| - if [ -n "${SHELLCHECK-}" ]; then shellcheck -s bash install.sh bash_completion nvm-exec ; fi | ||
| - if [ -z "${SHELLCHECK-}" ]; then make TEST_SUITE=$TEST_SUITE URCHIN=/tmp/urchin/package/urchin test-$SHELL ; fi | ||
| - if [ -z "${SHELLCHECK-}" ] && [ -z "${DOCTOCCHECK-}" ] ; then make TEST_SUITE=$TEST_SUITE URCHIN=/tmp/urchin/package/urchin test-$SHELL ; fi |
There was a problem hiding this comment.
this should probably check if [ -n "${SHELL-}" ] && [ -n "${TEST_SUITE}" ] instead :-) mind changing this? (if this one line change is in a separate commit I can pull that in ASAP)
PeterDaveHello
force-pushed
the
doctoc
branch
from
aa92e76
to
1689b17
Compare
[Docs] [Tests] Introduce doctoc for "Table of Contents" autogeneration
Introduce doctoc to help maintain "Table of Content", make the "Table of Content" maintenance work easier, and won't miss anything important.
Please review the change of README.markdown with whitespace ignored, could be easier to find out the real diff, you can also see there is a item missed before.