Documentation deployed via Vercel @ https://crazycrew.us
Contributing is easy! We use markdown files for the wiki so anyone can contribute with a little reading.
All .mdx files are located under content/docs, Each directory translates to a directory on the website.
- Simply edit the
.mdxfiles. - use the command
pnpm run start. - Go to http://localhost:4321
- Make changes until it looks right.
- Make a pull request once it looks right.
- You must know TypeScript and Astro/Vue if you plan to add things outside of
mdfiles.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install |
Installs dependencies |
pnpm dev |
Starts local dev server at localhost:4321 |
pnpm build |
Build your production site to ./dist/ |
pnpm preview |
Preview your build locally, before deploying |
pnpm astro ... |
Run CLI commands like astro add, astro check |
pnpm astro -- --help |
Get help using the Astro CLI |