my website
at main 68 lines 3.0 kB view raw view rendered
1# Astro Starter Kit: Blog 2 3```sh 4npm create astro@latest -- --template blog 5``` 6 7[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog) 8[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/blog) 9[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/blog/devcontainer.json) 10 11> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! 12 13![blog](https://github.com/withastro/astro/assets/2244813/ff10799f-a816-4703-b967-c78997e8323d) 14 15Features: 16 17- ✅ Minimal styling (make it your own!) 18- ✅ 100/100 Lighthouse performance 19- ✅ SEO-friendly with canonical URLs and OpenGraph data 20- ✅ Sitemap support 21- ✅ RSS Feed support 22- ✅ Markdown & MDX support 23 24## 🚀 Project Structure 25 26Inside of your Astro project, you'll see the following folders and files: 27 28```text 29├── public/ 30├── src/ 31│   ├── components/ 32│   ├── content/ 33│   ├── layouts/ 34│   └── pages/ 35├── astro.config.mjs 36├── README.md 37├── package.json 38└── tsconfig.json 39``` 40 41Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. 42 43There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. 44 45The `src/content/` directory contains "collections" of related Markdown and MDX documents. Use `getCollection()` to retrieve posts from `src/content/blog/`, and type-check your frontmatter using an optional schema. See [Astro's Content Collections docs](https://docs.astro.build/en/guides/content-collections/) to learn more. 46 47Any static assets, like images, can be placed in the `public/` directory. 48 49## 🧞 Commands 50 51All commands are run from the root of the project, from a terminal: 52 53| Command | Action | 54| :------------------------ | :----------------------------------------------- | 55| `npm install` | Installs dependencies | 56| `npm run dev` | Starts local dev server at `localhost:4321` | 57| `npm run build` | Build your production site to `./dist/` | 58| `npm run preview` | Preview your build locally, before deploying | 59| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | 60| `npm run astro -- --help` | Get help using the Astro CLI | 61 62## 👀 Want to learn more? 63 64Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). 65 66## Credit 67 68This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).