stdf/doc/guide/quickStart_en.md

Tip：All code or commands can be double-clicked to select the word, three clicks to select the line.

😉 Existing works

Install

Svelte and Tailwind have been configured for direct installation.

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

Used in Svelte

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

<Button>Default</Button>

😓 No works

Use create-stdf

You can try using create-stdf to quickly create a project. (beta version)

pnpm create stdf
# or
npm create stdf@latest
# or
npm init stdf@latest
# or
npx create-stdf@latest

Build your own project

Use the Vite example to create the project here. See Vite documentation.

npm create vite@latest

Follow the prompts to create a project.

Configuration Tailwind CSS. See Tailwind CSS documentation。

1. Install Tailwind CSS and other dependencies, then generate tailwind.config.js and postcss.config.js files.

   npm install -D tailwindcss postcss autoprefixer
   npx tailwindcss init -p
   

2. Add a template file within the tailwind.config.js file. Note that ./node_modules/stdf/src/**/*.svelte is added in content, which is the component location of STDF.The colors of theme can be modified according to its own needs. Reference STDF Guide - Color.

Note: The 'content' in the Tailwind configuration file represents all files that may use Tailwind, please do not omit any files. Please set darkMode to 'class' to match STDF's dark mode.

/** @type {import('tailwindcss').Config} */
module.exports = {
    // ...
    content: ['./index.html', './src/**/*.svelte', './node_modules/stdf/src/**/*.svelte'],
    theme: {
        colors: {
            // Theme Color
            primary: '#0B24FB',
            dark: '#FFC043',
            blue: '#0B24FB', // primary alias
            yellow: '#FFC043', // dark alias

            // Extended Color
            purple: '#7356BF',
            green: '#05944F',
            orange: '#FF6937',

            // Functional Color
            success: '#11BB8D',
            warning: '#B95000',
            error: '#DA1414',
            info: '#2E5AAC',

            // Neutral Color
            black: '#000000',
            white: '#fff',
            gray1: '#23262B',
            gray2: '#2A2B2F',
            gray3: '#303239',
            gray4: '#373940',
            gray5: '#414249',
            gray6: '#747B84',
            gray7: '#DADEE3',
            gray8: '#EBEEF2',
            gray9: '#F4F6F9',
            gray10: '#FAFAFB',
            transparent: 'transparent',
        },
    },
    darkMode: 'class',
    // ...
};

1. Add Tailwind CSS to the entry CSS file, such as./src/index.css, and import the CSS file in the entry file main.js.

2. Start the project.

   npm run dev