quickStart.md 2.2 KB

Tip:所有代码或命令可以双击选定词,三击选定行。

😉 已有工程

安装

已有配置好 Svelte 与 Tailwind 的工程,直接安装。

npm i stdf -D
# or
pnpm i stdf -D

在 Svelte 中使用

<!-- Button Demo -->
<script>
import { Button } from 'stdf';
</script>

<Button>默认</Button>

😓 无工程

搭建工程

此处用 Vite 示例创建工程,参考 Vite 文档

npm create vite@latest

按照提示操作创建工程。

配置 Tailwind CSS

参考 Tailwind CSS 文档

  1. 安装 Tailwind CSS 和其他依赖,然后生成 tailwind.config.jspostcss.config.js 文件。

    npm install -D tailwindcss postcss autoprefixer
    npx tailwindcss init -p
    
  2. tailwind.config.js 文件内添加模板文件。注意 content 内添加./node_modules/stdf/src/**/*.svelte,这是 STDF 的组件位置。其中 theme 的 colors 可以根据自己的需要进行修改。可参考 STDF 指南 - 色彩

    /** @type {import('tailwindcss').Config} */
    module.exports = {
    // ...
    content: ['./index.html', './src/**/*.{html,js,svelte}', './node_modules/stdf/src/**/*.svelte'],
    theme: {
        colors: {
            primary: '#0B24FB',
            dark: '#FFC043',
            purple: '#7356BF',
            green: '#05944F',
            orange: '#FF6937',
            black: '#000000',
            gray1: '#23262B',
            gray2: '#2A2B2F',
            gray3: '#303239',
            gray4: '#373940',
            gray5: '#414249',
            gray6: '#747B84',
            gray7: '#DADEE3',
            gray8: '#EBEEF2',
            gray9: '#F4F6F9',
            gray10: '#FAFAFB',
            success: '#11BB8D',
            warning: '#B95000',
            error: '#DA1414',
            info: '#2E5AAC',
            transparent: 'transparent',
        },
    },
    darkMode: 'class',
    // ...
    };
    
  3. 将 Tailwind CSS 添加到入口 CSS 文件中,如 ./src/index.css,并在入口文件 main.js 中引入这个 CSS 文件。

  4. 启动项目。

    npm run dev