Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.12 KB

Contributing

🚀 Project Structure

Inside of the Astro project, you'll see the following folders and files:

/
├── public/
├── src/
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .md files in the src/principles/ directory. Each principle is exposed as a list in index.astro.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands

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:3000
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