Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
Code Issues Activity
astro/examples/blog
History
Ian Bull 55f007f30a
Support Prism in the blog template example (#2622) 
The Prism syntax highlighter failed to render properly when Astro was
initialized with the blog template. This was because the Prism CSS
conflicted with the default blog template.

This change-set removes the Viewport Width from the `pre` transform as
this property conflicted with the prism CSS. This change-set also
includes Prism in the Blog Post layout and adds a small javascript
example to the sample post.
2022-03-10 11:49:52 -06:00
..
public move styles to src (#2003) 2021-11-24 11:10:12 -08:00
src Support Prism in the blog template example (#2622) 2022-03-10 11:49:52 -06: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 Chore: configure buildOptions.site on examples/blog (#2590) 2022-02-17 07:40:51 -05:00
package.json [ci] release (next) (#2734) 2022-03-09 19:01:26 -06: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

Open in StackBlitz

🧑‍🚀 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.