Chaldea Docs

Documentation for Chaldea app. Powered by VitePress.

Documentation

https://docs.chaldea.center/

https://docs.chaldea.center/zh/

Contributing

VitePress Document

Requirement: node 18+

# enable pnpm
corepack enable
corepack prepare pnpm@latest --activate

# Install dependencies
pnpm install

# Serve the docs site in the local server
# http://localhost:8080
pnpm run docs:dev

# Edit or create markdown files
...

# Format
pnpm run docs:format
# or
npm run docs:format
# or
prettier --write .

# Make sure build passed
pnpm run docs:build

# commit & push
git pull && git add -A && git commit -m "msg" && git push

Structure

• docs/: English docs
• docs/zh/: Chinese docs
• docs/.vitepress/configs/sidebar/: Sidebars

Keep the same structure for English and Chinese. Add new page for all languages and add them to sidebars.

License

MIT