valaxyjs/valaxy-theme-starter

Valaxy-Theme-Starter^(vue)

This is a template for creating a valaxy theme.

Usage

Use pnpm, because we need its workspace.

npx degit YunYouJun/valaxy-theme-starter valaxy-theme-name

cd valaxy-theme-name

# If you don't have pnpm installed
npm install -g pnpm

pnpm i

# dev node
pnpm dev
# dev client
pnpm demo

pnpm build

Publish to npm.

pnpm ci:publish

You can release it by github actions.

Click Settings -> Secrets -> Actions in your GitHub repo.

Add New repository secret:

NPM_TOKEN: your npm token (Generate from your npm Access Tokens - Automation)

npm run release
# choose your version to automatic release

[ ] Change the author name in LICENSE & package.json & .github
[ ] Write ThemeConfig & Other init content
[ ] Rename valaxy-theme-starter to valaxy-theme-<name> (custom it)
[ ] Change theme: 'starter' to theme: <name> in valaxy.config.ts
[ ] Each of your Vue components should have a namespace
- For example: YunTest.vue for valaxy-theme-yun

Rename valaxy-theme-starter with valaxy-theme-name in the package.json and valaxy.config.ts files.

PS: there are a total of four files that need to be rename

valaxy-theme-name
  - package.json
  - demo
    - package.json
    - valaxy.config.ts
  - theme
    - package.json

Let's write the theme & docs!

Starter theme ref theme: