ksk-core
Version:
Core design system components and styles for Kickstart projects
58 lines (42 loc) • 932 B
Markdown
# @kickstart/ksk-core
Core design system components and styles for Kickstart projects.
## Installation
```bash
npm install @kickstart/ksk-core
```
## Usage
### Import styles
```scss
@use '@kickstart/ksk-core/styles' as ksk;
```
### Import components
```astro
import Button from '@kickstart/ksk-core/components/Button/Button.astro';
import Layout from '@kickstart/ksk-core/layouts/Layout.astro';
```
### Initialize JavaScript
```js
import '@kickstart/ksk-core';
```
## Development
```bash
npm install
npm run dev # Start demo server
npm run build # Build for distribution
npm run icons # Rebuild icon font
```
## Local Development
To use a local version of ksk-core in your projects:
```bash
# In ksk-core directory
npm link
# In your project directory
npm link @kickstart/ksk-core
```
When you're done developing:
```bash
npm unlink @kickstart/ksk-core
npm install @kickstart/ksk-core@latest
```