|
1 | | -[](https://gitpod.io/#https://github.com/RadValentin/valentin.io) |
| 1 | +# valentin.io |
2 | 2 |
|
3 | 3 |  |
4 | 4 |
|
5 | | -## Notes |
| 5 | +```sh |
| 6 | +npm create astro@latest -- --template blog |
| 7 | +``` |
6 | 8 |
|
7 | | -If you're on Windows, please run `npm install windows-build-tools -g` from PowerShell with admin rights before installing the npm dependencies [[read more]](https://www.gatsbyjs.org/docs/gatsby-on-windows/). |
| 9 | +> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
| 10 | +
|
| 11 | +Features: |
| 12 | + |
| 13 | +- ✅ Minimal styling (make it your own!) |
| 14 | +- ✅ 100/100 Lighthouse performance |
| 15 | +- ✅ SEO-friendly with canonical URLs and Open Graph data |
| 16 | +- ✅ Sitemap support |
| 17 | +- ✅ RSS Feed support |
| 18 | +- ✅ Markdown & MDX support |
| 19 | + |
| 20 | +## 🚀 Project Structure |
| 21 | + |
| 22 | +Inside of your Astro project, you'll see the following folders and files: |
| 23 | + |
| 24 | +```text |
| 25 | +├── public/ |
| 26 | +├── src/ |
| 27 | +│ ├── assets/ |
| 28 | +│ ├── components/ |
| 29 | +│ ├── content/ |
| 30 | +│ ├── layouts/ |
| 31 | +│ └── pages/ |
| 32 | +├── astro.config.mjs |
| 33 | +├── README.md |
| 34 | +├── package.json |
| 35 | +└── tsconfig.json |
| 36 | +``` |
| 37 | + |
| 38 | +Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. |
| 39 | + |
| 40 | +There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. |
| 41 | + |
| 42 | +The `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. |
| 43 | + |
| 44 | +Any static assets, like images, can be placed in the `public/` directory. |
| 45 | + |
| 46 | +## 🧞 Commands |
| 47 | + |
| 48 | +All commands are run from the root of the project, from a terminal: |
| 49 | + |
| 50 | +| Command | Action | |
| 51 | +| :------------------------ | :----------------------------------------------- | |
| 52 | +| `npm install` | Installs dependencies | |
| 53 | +| `npm run dev` | Starts local dev server at `localhost:4321` | |
| 54 | +| `npm run build` | Build your production site to `./dist/` | |
| 55 | +| `npm run preview` | Preview your build locally, before deploying | |
| 56 | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | |
| 57 | +| `npm run astro -- --help` | Get help using the Astro CLI | |
| 58 | + |
| 59 | +## 👀 Want to learn more? |
| 60 | + |
| 61 | +Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
| 62 | + |
| 63 | +## Credit |
| 64 | + |
| 65 | +This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/). |
0 commit comments