Qihan/MyBlog-Next
1
0
Fork 0
mirror of https://github.com/ChenQihan666/MyBlog-Next.git synced 2026-08-14 07:33:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README for new changes

Browse Source
This commit is contained in:
satnaing
2022-11-28 23:12:20 +06:30
parent 7788331d36
commit 825f8cb6e4
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -6
View File
@@ -6,23 +6,27 @@
[![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 and SEO-friendly Astro blog theme. This theme is designed and crafted based on [my personal blog](https://satnaing.dev/blog).
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 is aimed to be accessible out of the box. Light and dark mode are supported by default and additional color schemes can also be configured.
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. So, see the documentation for more info.
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] super fast performance
- [x] fully responsive and accessible
- [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
_Note: I've manually made the VoiceOver accessibility tests using the default VoiceOver on Mac; and haven't tested using other software. But VoiceOver accessibility enhancements in this website should be working fine on others as well._
## 🚀 Project Structure
Inside of AstroPaper, you'll see the following folders and files:
@@ -36,6 +40,7 @@ Inside of AstroPaper, you'll see the following folders and files:
│ └── favicon.svg
│ └── default-og.png
│ └── robots.txt
│ └── toggle-theme.js
├── src/
│ ├── assets/
│ │ └── socialIcons.ts
@@ -75,6 +80,7 @@ Documentation can be read in two formats\_ _markdown_ & _blog post_.
**UI/UX** - [Figma](https://figma.com)
**Fuzzy Search** - [FuseJS](https://fusejs.io/)
**Icons** - [Boxicons](https://boxicons.com/) | [Tablers](https://tabler-icons.io/)
**Code Formatting** - [Prettier](https://prettier.io/)
**Deployment** - [Cloudflare Pages](https://pages.cloudflare.com/)
**Illustration in About Page** - [https://freesvgillustration.com](https://freesvgillustration.com/)
@@ -117,6 +123,6 @@ If you have any suggestions/feedback, you can contact me via [my email](mailto:c
Licensed under the MIT License, Copyright © 2022
---
---
Made with 🤍 by [Sat Naing](https://satnaing.dev) 👨🏻‍💻
Made with 🤍 by [Sat Naing](https://satnaing.dev) 👨🏻‍💻