forked from nixcn/nixcn-web
Noa Virellia
8bcc73bab5
- Added prettier-plugin-astro as dev dependency
- Removed incorrect top-level "typescript" parser config
- This causes the MDX files be parsed as typescript and error out.
Signed-off-by: Noa Virellia <noa@requiem.garden>
Nix CN Web
Contribution
- Root docs serve the zh-CN version [MUST]
- Use sign-off via
git commit -s[MUST] - Do not modify the
mainbranch for any reason [MUST] - Do not omit the commit subject for any reason [MUST]
- Describe all changes in the commit message [MUST]
- Rebase before submitting patches [MUST]
- Commit message written in english [MUST]
- Split commits for large or multi-part changes [OPTION]
- Use OpenPGP/SSH for commit signing [OPTION]
- Have fun contributing :) [VERY NECESSARY]
Toolchain
- Nix
- Devenv
- Direnv
- Node 22
- Pnpm 10
- Corepack
- Cloudflare
- Zed Editor
Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
yarn install |
Installs dependencies |
yarn dev |
Starts local dev server at localhost:4321 |
yarn build |
Build your production site to ./dist/ |
yarn preview |
Preview your build locally, before deploying |
yarn astro ... |
Run CLI commands like astro add, astro check |
yarn astro -- --help |
Get help using the Astro CLI |