Skip to content

Collaborative Markdown writing platform for group projects! Written in Astro.

Notifications You must be signed in to change notification settings

VoxelMC/collabowrite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

49352dc Β· Apr 8, 2024

History

42 Commits
Jan 4, 2024
Feb 26, 2024
Mar 7, 2024
Apr 8, 2024
Feb 22, 2024
Jan 4, 2024
Feb 22, 2024
Mar 7, 2024
Feb 27, 2024
Feb 9, 2024
Feb 21, 2024
Mar 16, 2024

Repository files navigation

Astro Starter Kit: Basics

npm create astro@latest -- --template basics

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

πŸ§‘β€πŸš€ Seasoned astronaut? Delete this file. Have fun!

just-the-basics

πŸš€ Project Structure

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

/
β”œβ”€β”€ public/
β”‚   └── favicon.svg
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/
β”‚   β”‚   └── Card.astro
β”‚   β”œβ”€β”€ layouts/
β”‚   β”‚   └── Layout.astro
β”‚   └── pages/
β”‚       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

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
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

πŸ‘€ Want to learn more?

Feel free to check our documentation or jump into our Discord server.

About

Collaborative Markdown writing platform for group projects! Written in Astro.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published