Skip to content

Commit e19c3c0

Browse files
authored
Update README.md (#11)
1 parent f6683b6 commit e19c3c0

File tree

1 file changed

+2
-75
lines changed

1 file changed

+2
-75
lines changed

README.md

+2-75
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,8 @@
1-
# AstroPaper 📄
2-
3-
![AstroPaper](public/astropaper-og.jpg)
4-
![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
5-
![GitHub](https://img.shields.io/github/license/satnaing/astro-paper?color=%232F3741&style=for-the-badge)
6-
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white&style=for-the-badge)](https://conventionalcommits.org)
7-
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)
8-
9-
AstroPaper is a minimal, responsive, accessible and SEO-friendly Astro blog theme. This theme is designed and crafted based on [my personal blog](https://satnaing.dev/blog).
10-
11-
This theme follows best practices and provides accessibility out of the box. Light and dark mode are supported by default. Moreover, additional color schemes can also be configured.
12-
13-
This theme is self-documented \_ which means articles/posts in this theme can also be considered as documentations. Read [the blog posts](https://astro-paper.pages.dev/posts/) or check [the README Documentation Section](#-documentation) for more info.
14-
15-
## 🔥 Features
16-
17-
- [x] type-safe markdown
18-
- [x] super fast performance
19-
- [x] accessible (Keyboard/VoiceOver)
20-
- [x] responsive (mobile ~ desktops)
21-
- [x] SEO-friendly
22-
- [x] light & dark mode
23-
- [x] fuzzy search
24-
- [x] draft posts & pagination
25-
- [x] sitemap & rss feed
26-
- [x] followed best practices
27-
- [x] highly customizable
28-
- [x] dynamic OG image generation for blog posts [#15](https://github.com/satnaing/astro-paper/pull/15) ([Blog Post](https://astro-paper.pages.dev/posts/dynamic-og-image-generation-in-astropaper-blog-posts/))
29-
30-
_Note: I've tested screen-reader accessibility of AstroPaper using **VoiceOver** on Mac and **TalkBack** on Android. I couldn't test all other screen-readers out there. However, accessibility enhancements in AstroPaper should be working fine on others as well._
31-
32-
## ✅ Lighthouse Score
33-
34-
<p align="center">
35-
<a href="https://pagespeed.web.dev/report?url=https%3A%2F%2Fastro-paper.pages.dev%2F&form_factor=desktop">
36-
<img width="710" alt="AstroPaper Lighthouse Score" src="AstroPaper-lighthouse-score.svg">
37-
<a>
38-
</p>
1+
# OpenBytes Site
392

403
## 🚀 Project Structure
414

42-
Inside of AstroPaper, you'll see the following folders and files:
5+
Inside of Site, you'll see the following folders and files:
436

447
```bash
458
/
@@ -100,30 +63,6 @@ Documentation can be read in two formats\_ _markdown_ & _blog post_.
10063
**Illustration in About Page** - [https://freesvgillustration.com](https://freesvgillustration.com/)
10164
**Linting** - [ESLint](https://eslint.org)
10265

103-
## 👨🏻‍💻 Running Locally
104-
105-
The easiest way to run this project locally is to run the following command in your desired directory.
106-
107-
```bash
108-
# npm 6.x
109-
npm create astro@latest --template satnaing/astro-paper
110-
111-
# npm 7+, extra double-dash is needed:
112-
npm create astro@latest -- --template satnaing/astro-paper
113-
114-
# yarn
115-
yarn create astro --template satnaing/astro-paper
116-
```
117-
118-
## Google Site Verification (optional)
119-
120-
You can easily add your [Google Site Verification HTML tag](https://support.google.com/webmasters/answer/9008080#meta_tag_verification&zippy=%2Chtml-tag) in AstroPaper using environment variable. This step is optional. If you don't add the following env variable, the google-site-verification tag won't appear in the html `<head>` section.
121-
122-
```bash
123-
# in your environment variable file (.env)
124-
PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-value
125-
```
126-
12766
## 🧞 Commands
12867

12968
All commands are run from the root of the project, from a terminal:
@@ -139,15 +78,3 @@ All commands are run from the root of the project, from a terminal:
13978
| `npm run sync` | Generates TypeScript types for all Astro modules. [Learn more](https://docs.astro.build/en/reference/cli-reference/#astro-sync). |
14079
| `npm run cz` | Commit code changes with commitizen |
14180
| `npm run lint` | Lint with ESLint |
142-
143-
## ✨ Feedback & Suggestions
144-
145-
If you have any suggestions/feedback, you can contact me via [my email](mailto:[email protected]). Alternatively, feel free to open an issue if you find bugs or want to request new features.
146-
147-
## 📜 License
148-
149-
Licensed under the MIT License, Copyright © 2023
150-
151-
---
152-
153-
Made with 🤍 by [Sat Naing](https://satnaing.dev) 👨🏻‍💻

0 commit comments

Comments
 (0)