Skip to content

Commit 01534f1

Browse files
author
Matt Willer
authored
Build command docs on separate pages (#139)
By default, oclif autogenerates all command documentation into the README during release. Since we have a large number of commands, this results in 5,000+ lines in the README, which seems like too much for a developer to sort through. There's an option to instead write the docs to separate files by topic; this option has been added to the applicable commands in the release scripts.
1 parent 5cd5eee commit 01534f1

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@
129129
"test": "nyc mocha \"test/**/*.test.js\"",
130130
"posttest": "npm run lint",
131131
"lint": "eslint --fix ./src ./test",
132-
"prepack": "oclif-dev manifest && oclif-dev readme && npm shrinkwrap && git checkout origin/master -- package-lock.json",
132+
"prepack": "oclif-dev manifest && oclif-dev readme --multi && npm shrinkwrap && git checkout origin/master -- package-lock.json",
133133
"postpack": "rm -f oclif.manifest.json && rm -f npm-shrinkwrap.json",
134-
"version": "oclif-dev readme && git add README.md",
134+
"version": "oclif-dev readme --multi && git add README.md && git add docs",
135135
"build": "oclif-dev pack:macos && rm -rf tmp/ && oclif-dev pack:win && rm -rf tmp/"
136136
}
137137
}

0 commit comments

Comments
 (0)