Skip to content

Commit 3c5a192

Browse files
committed
Updated readme
1 parent 6121f97 commit 3c5a192

File tree

1 file changed

+33
-47
lines changed

1 file changed

+33
-47
lines changed

README.md

Lines changed: 33 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,54 @@
1-
# Astro Starter Kit: Blog
1+
# My Personal Site
22

3-
```sh
4-
npm create astro@latest -- --template blog
5-
```
3+
Welcome to my personal blog/portfolio site powered by Astro JS! 🚀
64

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)
5+
## Getting Started
106

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
7+
To set up this site on your machine, follow these simple steps:
128

13-
![blog](https://github.com/withastro/astro/assets/2244813/ff10799f-a816-4703-b967-c78997e8323d)
9+
```bash
10+
git clone https://github.com/devinschulz/blog.git
1411

15-
Features:
12+
cd blog
1613

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+
```
2316

24-
## 🚀 Project Structure
17+
## Development
2518

26-
Inside of your Astro project, you'll see the following folders and files:
19+
Run the local development server:
2720

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
3923
```
4024

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
4228

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:
4430

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+
```
4634

47-
Any static assets, like images, can be placed in the `public/` directory.
35+
The production-ready files will be in the `./dist/` directory.
4836

49-
## 🧞 Commands
37+
## Preview Before Deployment
5038

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:
5240

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+
```
6144

62-
## 👀 Want to learn more?
45+
This command allows you to preview your build locally.
6346

64-
Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
47+
## Additional Astro Commands
6548

66-
## Credit
49+
Explore more Astro commands for various tasks:
6750

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

Comments
 (0)