mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00

History

Ben Holmes 0a3d3e51a6 Feat: change to shiki default md renderer (#2824 ) * feat: change Shiki to default * refactor: update blog styles for shiki * feat: update examples/docs styles for Shiki * refactor: remove Prism-ish examples/docs styles * refactor: simplify rules with `all: unset` * refactor: remove Prism styles * refactor: examples/with-md remove Prism-specific line-highlight * chore: add changeset * chore: update changeset versions * refactor: update syntax highlight test for scoped styles * fix: apply scoped style class to pre and span lines * feat: test that scoped styles cascade to shiki code * refactor: pass scopedClassName explicitly		2022-03-18 17:29:51 -04:00
..
public	move styles to src (#2003 )	2021-11-24 11:10:12 -08:00
src	Feat: change to shiki default md renderer (#2824 )	2022-03-18 17:29:51 -04:00
.gitignore	Normalize and cleanup examples projects (#2364 )	2022-01-12 10:37:16 -05:00
.npmrc	Move from yarn to pnpm (#2455 )	2022-03-08 15:46:11 -06:00
.stackblitzrc	update examples for stackblitz (#1379 )	2021-09-16 08:06:22 -07:00
astro.config.mjs	Export defineConfig helper (#2803 )	2022-03-15 15:27:17 -05:00
package.json	[ci] release (#2808 )	2022-03-15 19:40:27 -05:00
README.md	update repo URL (#1994 )	2021-11-23 14:47:05 -08:00
sandbox.config.json	Adding CodeSandbox config file to all the "next" examples (#1744 )	2021-11-05 10:41:37 -05:00
tsconfig.json	Adjust TSConfig example files to include compilerOptions (#2278 )	2021-12-26 22:39:30 -05:00

README.md

Astro Starter Kit: Blog

npm init astro -- --template blog

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

Features:

✅ SEO-friendly setup with canonical URLs and OpenGraph data
✅ Full Markdown support
✅ RSS 2.0 generation
✅ Sitemap.xml generation

🚀 Project Structure

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

/
├── public/
│   ├── robots.txt
│   └── favicon.ico
├── src/
│   ├── components/
│   │   └── Tour.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:3000`
`npm run build`	Build your production site to `./dist/`
`npm run preview`	Preview your build locally, before deploying

👀 Want to learn more?

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