Updated README
This commit is contained in:
parent
a7ebe198c9
commit
1a279dbf85
30
README.md
30
README.md
@ -1,8 +1,28 @@
|
|||||||
# Welcome to [Astro](https://astro.build)
|
# [Astro](https://astro.build) Blog Template
|
||||||
|
|
||||||
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/starter)
|
![Screenshot](screenshot.png)
|
||||||
|
|
||||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
## 👉 Check out the [✨ Live Demo ✨](https://astro-blog-template.netlify.app/)
|
||||||
|
|
||||||
|
## 👩🚀 Getting Started
|
||||||
|
|
||||||
|
### Locally
|
||||||
|
|
||||||
|
```
|
||||||
|
npm init astro -- --template Charca/astro-blog-template
|
||||||
|
```
|
||||||
|
|
||||||
|
### On StackBlitz
|
||||||
|
|
||||||
|
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/charca/astro-blog-template)
|
||||||
|
|
||||||
|
## ✨ Features:
|
||||||
|
|
||||||
|
- ✅ Dark Mode
|
||||||
|
- ✅ Full Markdown support
|
||||||
|
- ✅ SEO-friendly setup with canonical URLs and OpenGraph data
|
||||||
|
- ✅ RSS 2.0 generation
|
||||||
|
- ✅ Sitemap.xml generation
|
||||||
|
|
||||||
## 🚀 Project Structure
|
## 🚀 Project Structure
|
||||||
|
|
||||||
@ -34,10 +54,10 @@ All commands are run from the root of the project, from a terminal:
|
|||||||
| Command | Action |
|
| Command | Action |
|
||||||
|:---------------- |:-------------------------------------------- |
|
|:---------------- |:-------------------------------------------- |
|
||||||
| `npm install` | Installs dependencies |
|
| `npm install` | Installs dependencies |
|
||||||
| `npm run dev` | Starts local dev server at `localhost:3000` |
|
| `npm run dev` | Starts local dev server at `localhost:3030` |
|
||||||
| `npm run build` | Build your production site to `./dist/` |
|
| `npm run build` | Build your production site to `./dist/` |
|
||||||
| `npm run preview` | Preview your build locally, before deploying |
|
| `npm run preview` | Preview your build locally, before deploying |
|
||||||
|
|
||||||
## 👀 Want to learn more?
|
## 👀 Want to learn more?
|
||||||
|
|
||||||
Feel free to check [our documentation](https://github.com/withastro/astro) or jump into our [Discord server](https://astro.build/chat).
|
Feel free to check [Astro's documentation](https://github.com/withastro/astro) or jump into Astro's [Discord server](https://astro.build/chat).
|
||||||
|
11
TODO
11
TODO
@ -1,11 +0,0 @@
|
|||||||
[ ] Update README
|
|
||||||
[x] Install Fonts
|
|
||||||
[x] Style Code blocks
|
|
||||||
[x] Highlight current navigation item
|
|
||||||
[x] Use css variables
|
|
||||||
[x] Dark mode
|
|
||||||
[x] Resize Logo
|
|
||||||
[x] Reading time
|
|
||||||
[x] Bio component
|
|
||||||
[x] Add social image
|
|
||||||
[x] Add hero image to one of the posts
|
|
BIN
screenshot.png
Normal file
BIN
screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.4 MiB |
Loading…
Reference in New Issue
Block a user