diff --git a/README.md b/README.md index 77b07af..44d5ab3 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,8 @@ -# AstroPaper 📄 - -![AstroPaper](public/astropaper-og.jpg) -![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white) -![GitHub](https://img.shields.io/github/license/satnaing/astro-paper?color=%232F3741&style=for-the-badge) -[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white&style=for-the-badge)](https://conventionalcommits.org) -[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/) - -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). - -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. - -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. - -## 🔥 Features - -- [x] type-safe markdown -- [x] super fast performance -- [x] accessible (Keyboard/VoiceOver) -- [x] responsive (mobile ~ desktops) -- [x] SEO-friendly -- [x] light & dark mode -- [x] fuzzy search -- [x] draft posts & pagination -- [x] sitemap & rss feed -- [x] followed best practices -- [x] highly customizable -- [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/)) - -_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._ - -## ✅ Lighthouse Score - -

- - AstroPaper Lighthouse Score - -

+# OpenBytes Site ## 🚀 Project Structure -Inside of AstroPaper, you'll see the following folders and files: +Inside of Site, you'll see the following folders and files: ```bash / @@ -100,30 +63,6 @@ Documentation can be read in two formats\_ _markdown_ & _blog post_. **Illustration in About Page** - [https://freesvgillustration.com](https://freesvgillustration.com/) **Linting** - [ESLint](https://eslint.org) -## 👨🏻‍💻 Running Locally - -The easiest way to run this project locally is to run the following command in your desired directory. - -```bash -# npm 6.x -npm create astro@latest --template satnaing/astro-paper - -# npm 7+, extra double-dash is needed: -npm create astro@latest -- --template satnaing/astro-paper - -# yarn -yarn create astro --template satnaing/astro-paper -``` - -## Google Site Verification (optional) - -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 `` section. - -```bash -# in your environment variable file (.env) -PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-value -``` - ## 🧞 Commands 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: | `npm run sync` | Generates TypeScript types for all Astro modules. [Learn more](https://docs.astro.build/en/reference/cli-reference/#astro-sync). | | `npm run cz` | Commit code changes with commitizen | | `npm run lint` | Lint with ESLint | - -## ✨ Feedback & Suggestions - -If you have any suggestions/feedback, you can contact me via [my email](mailto:contact@satnaing.dev). Alternatively, feel free to open an issue if you find bugs or want to request new features. - -## 📜 License - -Licensed under the MIT License, Copyright © 2023 - ---- - -Made with 🤍 by [Sat Naing](https://satnaing.dev) 👨🏻‍💻