Skip to content

Commit 845f8d1

Browse files
committed
Update README.md
1 parent f9105c9 commit 845f8d1

1 file changed

Lines changed: 5 additions & 43 deletions

File tree

README.md

Lines changed: 5 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,8 @@
1-
# Astro Starter Kit: Blog
1+
# Wiringbits website & blog
22

3-
```sh
4-
npm create astro@latest -- --template blog
5-
```
3+
This is the website & blog for [Wiringbits](https://wiringbits.net).
64

7-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
8-
9-
Features:
10-
11-
- ✅ Minimal styling (make it your own!)
12-
- ✅ 100/100 Lighthouse performance
13-
- ✅ SEO-friendly with canonical URLs and OpenGraph data
14-
- ✅ Sitemap support
15-
- ✅ RSS Feed support
16-
- ✅ Markdown & MDX support
17-
18-
## 🚀 Project Structure
19-
20-
Inside of your Astro project, you'll see the following folders and files:
21-
22-
```text
23-
├── public/
24-
├── src/
25-
│   ├── components/
26-
│   ├── content/
27-
│   ├── layouts/
28-
│   └── pages/
29-
├── astro.config.mjs
30-
├── README.md
31-
├── package.json
32-
└── tsconfig.json
33-
```
34-
35-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
36-
37-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
38-
39-
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.
40-
41-
Any static assets, like images, can be placed in the `public/` directory.
5+
It is powered by [Astro](https://astro.build/).
426

437
## 🧞 Commands
448

@@ -52,10 +16,8 @@ All commands are run from the root of the project, from a terminal:
5216
| `npm run preview` | Preview your build locally, before deploying |
5317
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
5418
| `npm run astro -- --help` | Get help using the Astro CLI |
55-
56-
## 👀 Want to learn more?
57-
58-
Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
19+
| `npx prettier . --check` | Check code format |
20+
| `npx prettier . --write` | Format code |
5921

6022
## Credit
6123

0 commit comments

Comments
 (0)