From b680afae44a1742506a1e29c222e6d93c913179e Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sat, 22 Jan 2022 12:50:40 -0800 Subject: [PATCH] docs(contributing): update guideline on re-building docs --- CONTRIBUTING.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f0d9cd5..2810f2cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,23 +121,15 @@ export { } from "./ComposedModal"; ``` -### Build +### Run `yarn build:docs` -Verify that you can build the library by running the following command at the project root: +Run the following command to re-generate TypeScript definitions and documentation. ```sh # carbon-components-svelte/ -yarn prepack +yarn build:docs ``` -This does several things: - -- uses `node-sass` to pre-compile CSS StyleSheets in the `css` folder -- uses Rollup to bundle the Svelte components in `src` in ESM/UMD formats; emitted to `lib` -- uses a Rollup plugin to: - - generate component documentation in Markdown format (`COMPONENT_INDEX.md`) - - generate TypeScript definitions (`types/index.d.ts`) - ## Submit a Pull Request ### Sync Your Fork