Participate in Development

• create-valaxy
• create-valaxy-theme

Todo ​

• create-valaxy
  • select theme to init (default: valaxy-theme-yun)
• Debug component.

Dev ​

You must use pnpm. Because we use its workspace.

git clone https://github.com/YunYouJun/valaxy
cd valaxy

pnpm i
# esbuild watch valaxy cli & valaxy-theme-yun
# and run demo

# build node cli
pnpm run build

# pnpm dev = pnpm dev:lib + pnpm demo
pnpm dev

Docs ​

We use valaxy to build docs. Just eat our own dog food.

If you want to use more out-of-the-box for docs, you can use VitePress.

# build latest valaxy cli
pnpm run build

pnpm run docs:build

If you want to display info better in two terminal (Recommended), follow below.

Node ​

# watch valaxy & valaxy-theme-yun
pnpm dev:lib

Client ​

If you only want to develop client.

• Docs: pnpm docs:dev
• Demo(theme-yun): pnpm demo