mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-21 20:59:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(contributing): update guideline on re-building docs

Browse source
This commit is contained in:
Eric Liu 2022-01-22 12:50:40 -08:00
commit b680afae44
1 changed files with 3 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

14
CONTRIBUTING.md
View file

@ -121,23 +121,15 @@ export {
} from "./ComposedModal"; } 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 ```sh
# carbon-components-svelte/ # 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 ## Submit a Pull Request
### Sync Your Fork ### Sync Your Fork