From e72d5b5bf9fcff39d29c0e1190d4faf2a6bfffa0 Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Thu, 23 Apr 2020 16:48:55 -0400 Subject: [PATCH] =?UTF-8?q?chore:=20=F0=9F=A4=96=20change=20toc=20command?= =?UTF-8?q?=20to=20doc:toc=20and=20add=20aggregate=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 3 ++- package.json | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5537660a5..ee4986748 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,8 @@ List of available project commands. `yarn run ` |---------------------|--------------------------------------------------------------------------------------------------------------------| | commit | Replaces `git commit`, ensures checks pass before commit is allowed and normalizes commit messages across authors. | | compliance:licenses | Checks that all dependencies have OSS-compatible licenses. | -| build:toc | Automatically generates a ToC for the README file. | +| doc | Executes all doc-related commands. | +| doc:toc | Automatically generates a table of contents for the README file. | ## Contributing diff --git a/package.json b/package.json index 46393a542..4d76439bc 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,8 @@ "precommit": "yarn compliance:licenses && yarn audit", "commit": "git-cz", "compliance:licenses": "license-checker --onlyAllow 'Apache License, Version 2.0;Apache-2.0;BSD;BSD-3-Clause;CC-BY-3.0;CC-BY-4.0;CC0-1.0;ISC;MIT;MPL-2.0;Public Domain;Unicode-TOU;Unlicense;WTFPL' --excludePackages 'watchtower-ui'", - "build:toc": "doctoc README.md" + "doc": "yarn doc:toc", + "doc:toc": "doctoc README.md" }, "devDependencies": { "cz-conventional-changelog": "^3.1.0",