Documentation for Chaldea app. Powered by Vuepress.
https://docs.chaldea.center/zh/
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
docs/
: English docsdocs/zh/
: Chinese docsdocs/.vuepress/configs/sidebar/
: Sidebars
Keep the same structure for English and Chinese. Add new page for all languages and add them to sidebars.