|
1 |
| -# Astro Starter Kit: Blog |
| 1 | +# My Personal Site |
2 | 2 |
|
3 |
| -```sh |
4 |
| -npm create astro@latest -- --template blog |
5 |
| -``` |
| 3 | +Welcome to my personal blog/portfolio site powered by Astro JS! 🚀 |
6 | 4 |
|
7 |
| -[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog) |
8 |
| -[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/blog) |
9 |
| -[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/blog/devcontainer.json) |
| 5 | +## Getting Started |
10 | 6 |
|
11 |
| -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
| 7 | +To set up this site on your machine, follow these simple steps: |
12 | 8 |
|
13 |
| - |
| 9 | +```bash |
| 10 | +git clone https://github.com/devinschulz/blog.git |
14 | 11 |
|
15 |
| -Features: |
| 12 | +cd blog |
16 | 13 |
|
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 |
| 14 | +npm install |
| 15 | +``` |
23 | 16 |
|
24 |
| -## 🚀 Project Structure |
| 17 | +## Development |
25 | 18 |
|
26 |
| -Inside of your Astro project, you'll see the following folders and files: |
| 19 | +Run the local development server: |
27 | 20 |
|
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 |
| 21 | +```bash |
| 22 | +npm run dev |
39 | 23 | ```
|
40 | 24 |
|
41 |
| -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. |
| 25 | +This will launch your site at `localhost:4321`. Feel free to customize the content, styles, and layouts to make it truly yours! |
| 26 | + |
| 27 | +## Building for Production |
42 | 28 |
|
43 |
| -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. |
| 29 | +When you're ready to deploy your blog, build the production version: |
44 | 30 |
|
45 |
| -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. |
| 31 | +```bash |
| 32 | +npm run build |
| 33 | +``` |
46 | 34 |
|
47 |
| -Any static assets, like images, can be placed in the `public/` directory. |
| 35 | +The production-ready files will be in the `./dist/` directory. |
48 | 36 |
|
49 |
| -## 🧞 Commands |
| 37 | +## Preview Before Deployment |
50 | 38 |
|
51 |
| -All commands are run from the root of the project, from a terminal: |
| 39 | +Want to see how your site will look before deploying? Run: |
52 | 40 |
|
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 | |
| 41 | +```bash |
| 42 | +npm run preview |
| 43 | +``` |
61 | 44 |
|
62 |
| -## 👀 Want to learn more? |
| 45 | +This command allows you to preview your build locally. |
63 | 46 |
|
64 |
| -Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
| 47 | +## Additional Astro Commands |
65 | 48 |
|
66 |
| -## Credit |
| 49 | +Explore more Astro commands for various tasks: |
67 | 50 |
|
68 |
| -This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/). |
| 51 | +```bash |
| 52 | +npm run astro ... # Run CLI commands like `astro add`, `astro check` |
| 53 | +npm run astro -- --help # Get help using the Astro CLI |
| 54 | +``` |
0 commit comments