Chaldea Docs

Documentation for Chaldea app. Powered by Vuepress.

Documentation

https://docs.chaldea.center/

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

Contributing

Vuepress Document

Requirement: node 14+

# Install yarn globally
npm install -g yarn

# Install dependencies
yarn

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

# Edit or create markdown files
...

# Format
yarn docs:format
# or
prettier --write .

# Make sure build passed
yarn docs:build

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

Structure

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

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

License

MIT