Skip to content

Commit

Permalink
📝 doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@kwchang0831
kwchang0831 committed Sep 11, 2022
1 parent d203edc commit a767913
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 68 deletions.
58 changes: 23 additions & 35 deletions README-zh.md
View file
Original file line number Diff line number Diff line change
@@ -1,40 +1,30 @@
<br/>
<div align="center">
<a href="https://svelte-qwer.vercel.app/"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/qwer.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/qwer.webp" /></a>
</div>
<br/>
<p align="right"><a href="README.md">English</a> | <strong>中文</strong></p>

<h1 align="center">QWER</h1>

<p align="center">
✒︎ 使用 SvelteKit 與 ❤ 打造的部落格生成器，簡單好用。
使用 <b>SvelteKit</b> 與 <b>❤</b> 精心打造的<b>部落格生成器</b>
</p>
<p align="center">
<a href="README.md"><img src="https://img.shields.io/badge/README-%E4%B8%AD%E6%96%87-lightgreen?style=for-the-badge&logo=Read the Docs" alt="Readme"></a>
<img src="https://img.shields.io/github/languages/top/kwchang0831/svelte-QWER?color=%23ff3e00&style=for-the-badge&logo=Svelte" alt="Language" />

<p align="center"><img src="https://img.shields.io/github/languages/top/kwchang0831/svelte-QWER?color=%23ff3e00&style=for-the-badge&logo=Svelte" alt="Language" />
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/kwchang0831/svelte-QWER?style=for-the-badge" alt="License"></a>
<a href="https://svelte-qwer.vercel.app/"><img src="https://img.shields.io/badge/🚀 示範網站-Vercel-informational?style=for-the-badge" alt="Readme"></a>
<a href="https://github.com/kwchang0831/svelte-QWER/discussions/categories/q-a"><img src="https://img.shields.io/badge/❓ 問題討論-Q&A-informational?style=for-the-badge" alt="Q&A"></a>
</p>
<a href="https://github.com/kwchang0831/svelte-QWER/discussions/categories/q-a"><img src="https://img.shields.io/badge/❓ 問題討論-Q&A-informational?style=for-the-badge" alt="Q&A"></a></p>

<p align="center">
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/CHANGELOG.md"><img src="https://img.shields.io/badge/更新日誌-Svelt--QWER-lightgreen?style=for-the-badge&logo=Keep a Changelog" alt="svelte-QWER"></a>
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/QWER/CHANGELOG.md"><img src="https://img.shields.io/badge/更新日誌-QWER-lightgreen?style=for-the-badge&logo=Keep a Changelog" alt="QWER"></a>
</p>
<p align="center"><a href="https://github.com/kwchang0831/svelte-QWER/blob/main/CHANGELOG.md"><img src="https://img.shields.io/badge/更新日誌-Svelt--QWER-lightgreen?style=for-the-badge&logo=Keep a Changelog" alt="svelte-QWER"></a>
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/QWER/CHANGELOG.md"><img src="https://img.shields.io/badge/更新日誌-QWER-lightgreen?style=for-the-badge&logo=Keep a Changelog" alt="QWER"></a></p>

<br/>

<p align="center">
<a href="https://raw.githubusercontent.com/gist/kwchang0831/acd18fa5e12de9be28a34617beffe5de/raw/metrics.pagespeed.svg"><img style="float:middle" width="auto" alt="PAGESPEED" src="https://raw.githubusercontent.com/gist/kwchang0831/acd18fa5e12de9be28a34617beffe5de/raw/metrics.pagespeed.svg"></a>
</p>
<p align="center"><img style="float:middle" width="auto" alt="PAGESPEED" src="https://raw.githubusercontent.com/gist/kwchang0831/acd18fa5e12de9be28a34617beffe5de/raw/metrics.pagespeed.svg"></p>

## 🎉 馬上嘗試看看 QWER

```bash
npx degit kwchang0831/svelte-QWER my-blog
```

<p align="center"><a href="https://svelte-qwer.vercel.app/"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp" /></a></p>
<p align="center"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp" /></p>
<br/>
<p align="center"><a href="https://svelte-qwer.vercel.app/"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" /></a></p>
<p align="center"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" /></p>

## ⚡️ 用法

Expand Down Expand Up @@ -84,28 +74,28 @@ npx degit kwchang0831/svelte-QWER my-blog

## ✨ 功能

- 使用 [Markdwon 語法](https://www.markdownguide.org/basic-syntax/)撰寫文章。
- ⚡ 超快的網站速度。接近完美的 [PageSpeed](https://pagespeed.web.dev/) 跑分。

- 🤗 SEO 友善，支援 meta, [Open Graph](https://ogp.me/), [Schema](https://schema.org/), [JSON-LD](https://json-ld.org/), [microformats2](https://indieweb.org/microformats2)。

- 超快的網站速度。接近完美的 [PageSpeed](https://pagespeed.web.dev/) 跑分。
- 🔎 站內搜尋功能。

- 手機優先 / 響應式的設計。

- SEO 友善，支援 meta, [Open Graph](https://ogp.me/), [Schema](https://schema.org/), [JSON-LD](https://json-ld.org/), [microformats2](https://indieweb.org/microformats2)。
- 使用 [Markdwon 語法](https://www.markdownguide.org/basic-syntax/)撰寫文章。

- 使用資料夾式的整理方式來新增部落格頁面。

- 站內搜尋功能。
- 多標籤過濾文章。

- 網誌可設定標籤，還有標籤過濾功能。
- 自動生成文章目錄。

- 網誌會自動生成文章目錄。
- 開箱即用的 [Atom feed](https://validator.w3.org/feed/docs/atom.html), Sitemap, [PWA](https://web.dev/progressive-web-apps/), [JSON Feed](https://www.jsonfeed.org/)。

- 開箱即用的 [Atom feed](https://validator.w3.org/feed/docs/atom.html), Sitemap, [PWA](https://web.dev/progressive-web-apps/)。
- 自動照片優化支援，透過 [vite-imagetools](https://github.com/JonasKruckenberg/imagetools)。

- 支援嵌入 Svelte 組件 與 使用 Javascript 搭配 [Markdwon 語法](https://www.markdownguide.org/basic-syntax/)。

- 自動照片優化支援，透過 [vite-imagetools](https://github.com/JonasKruckenberg/imagetools)。

- 支援 [Giscus](https://github.com/giscus/giscus) - 免費留言系統架設於 Github 討論版上。

- 使用 [UnoCSS](https://github.com/unocss/unocss) - 原子化的 CSS 引擎。
Expand All @@ -120,11 +110,11 @@ npx degit kwchang0831/svelte-QWER my-blog

## 👷 目前狀態

[QWER](https://github.com/kwchang0831/svelte-QWER) 現在處於很早期的階段，所以會有經常可能會有破壞性的改動，請多包涵。
[QWER](https://github.com/kwchang0831/svelte-QWER) 現在處於很早期的階段，所以經常會有破壞性的改動，請多包涵。

未來如果有更新，而且您也想應用更新，通常你只需要複製你的 `user` 資料夾覆蓋最新的 release。

請別忘了查看 CHANGELOG，看看你是否需要對 `user/config` 進行更新與調整。
請別忘了查看 CHANGELOG，看看你是否需要對 `user/config` 或其他地方進行更新與調整。

## ❓ 有任何使用上的問題

Expand All @@ -138,8 +128,6 @@ npx degit kwchang0831/svelte-QWER my-blog

## 🎉 支持

<a href="https://www.producthunt.com/posts/qwer?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-qwer" target="_blank" rel="noreferrer noopener"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=356641&theme=light" alt="QWER - ✒︎&#0032;Simply&#0032;Awesome&#0032;Blog&#0032;Starter&#0032;built&#0032;with&#0032;Svelte&#0032;and&#0032;❤ | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>

<div class="flex" style="display:inline-block; font-size: 24px; --un-bg-opacity: 1; background-color: rgba(255, 221, 0); border-radius: 0.5rem; padding: 12px 18px; border: 2px solid;">
<a class="flex" href="https://www.buymeacoffee.com/kwchang0831" style="color: black;" >
<span>🥓</span>
Expand Down
54 changes: 21 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,40 +1,30 @@
<br/>
<div align="center">
<a href="https://svelte-qwer.vercel.app/"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/qwer.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/qwer.webp" /></a>
</div>
<br/>
<p align="right"><strong>English</strong> | <a href="README-zh.md">中文</a></p>

<h1 align="center">QWER</h1>

<p align="center">
✒︎ Simply Awesome Blog Starter built with SvelteKit and ❤
Simply Awesome <b>Blog Starter</b> built with <b>SvelteKit</b> and <b>❤</b>
</p>
<p align="center">
<a href="README-zh.md"><img src="https://img.shields.io/badge/README-%E4%B8%AD%E6%96%87-lightgreen?style=for-the-badge&logo=Read the Docs" alt="Readme"></a>
<img src="https://img.shields.io/github/languages/top/kwchang0831/svelte-QWER?color=%23ff3e00&style=for-the-badge&logo=Svelte" alt="Language" />

<p align="center"><img src="https://img.shields.io/github/languages/top/kwchang0831/svelte-QWER?color=%23ff3e00&style=for-the-badge&logo=Svelte" alt="Language" />
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/kwchang0831/svelte-QWER?style=for-the-badge" alt="License"></a>
<a href="https://svelte-qwer.vercel.app/"><img src="https://img.shields.io/badge/🚀 DEMO-Vercel-informational?style=for-the-badge" alt="Readme"></a>
<a href="https://github.com/kwchang0831/svelte-QWER/discussions/categories/q-a"><img src="https://img.shields.io/badge/❓ Discussion-Q&A-informational?style=for-the-badge" alt="Q&A"></a>
</p>
<a href="https://github.com/kwchang0831/svelte-QWER/discussions/categories/q-a"><img src="https://img.shields.io/badge/❓ Discussion-Q&A-informational?style=for-the-badge" alt="Q&A"></a></p>

<p align="center">
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/CHANGELOG.md"><img src="https://img.shields.io/badge/CHANGELOG-Svelt--QWER-lightgreen?style=for-the-badge&logo=Keep a Changelog" alt="svelte-QWER"></a>
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/QWER/CHANGELOG.md"><img src="https://img.shields.io/badge/CHANGELOG-QWER-lightgreen?style=for-the-badge&logo=Keep a Changelog" alt="QWER"></a>
</p>
<p align="center"><a href="https://github.com/kwchang0831/svelte-QWER/blob/main/CHANGELOG.md"><img src="https://img.shields.io/badge/CHANGELOG-Svelt--QWER-lightgreen?style=for-the-badge&logo=Keep a Changelog" alt="svelte-QWER"></a>
<a href="https://github.com/kwchang0831/svelte-QWER/blob/main/QWER/CHANGELOG.md"><img src="https://img.shields.io/badge/CHANGELOG-QWER-lightgreen?style=for-the-badge&logo=Keep a Changelog" alt="QWER"></a></p>

<br/>

<p align="center">
<a href="https://raw.githubusercontent.com/gist/kwchang0831/acd18fa5e12de9be28a34617beffe5de/raw/metrics.pagespeed.svg"><img style="float:middle" width="auto" alt="PAGESPEED" src="https://raw.githubusercontent.com/gist/kwchang0831/acd18fa5e12de9be28a34617beffe5de/raw/metrics.pagespeed.svg"></a>
</p>
<p align="center"><img style="float:middle" width="auto" alt="PAGESPEED" src="https://raw.githubusercontent.com/gist/kwchang0831/acd18fa5e12de9be28a34617beffe5de/raw/metrics.pagespeed.svg"></p>

## 🎉 Try it out

```bash
npx degit kwchang0831/svelte-QWER my-blog
```

<p align="center"><a href="https://svelte-qwer.vercel.app/"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" /></a></p>
<p align="center"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" /></p>
<br/>
<p align="center"><a href="https://svelte-qwer.vercel.app/"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" /></a></p>
<p align="center"><img src="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" alt="https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp" /></p>

## ⚡️ Usage

Expand Down Expand Up @@ -84,23 +74,23 @@ npx degit kwchang0831/svelte-QWER my-blog

## ✨ Features

- Writing post with [Markdown syntax](https://www.markdownguide.org/basic-syntax/).
- ⚡ Outstanding site performance. Near perfect [PageSpeed](https://pagespeed.web.dev/) score.

- Outstanding site performance. Near perfect [PageSpeed](https://pagespeed.web.dev/) score.
- 🤗 SEO friendly through meta, [Open Graph](https://ogp.me/), [Schema](https://schema.org/), [JSON-LD](https://json-ld.org/), [microformats2](https://indieweb.org/microformats2).

- 🔎 On-site Search.

- Mobile-First / Responsive design.

- SEO friendly through meta, [Open Graph](https://ogp.me/), [Schema](https://schema.org/), [JSON-LD](https://json-ld.org/), [microformats2](https://indieweb.org/microformats2).
- Writing post with [Markdown syntax](https://www.markdownguide.org/basic-syntax/).

- Folder-based organization for creating posts.

- On-site Search.
- Multi-Tags filtering.

- Post with tags and tag filtering feature.
- Auto-Generate Table of Content for posts.

- Post with auto generated table of content.

- Out-of-the-box support for [Atom feed](https://validator.w3.org/feed/docs/atom.html), Sitemap, [PWA](https://web.dev/progressive-web-apps/).
- Out-of-the-box support for [Atom feed](https://validator.w3.org/feed/docs/atom.html), Sitemap, [PWA](https://web.dev/progressive-web-apps/), [JSON Feed](https://www.jsonfeed.org/).

- Automatic image optimization via [vite-imagetools](https://github.com/JonasKruckenberg/imagetools).

Expand All @@ -126,7 +116,7 @@ For now, if there are updates, and if you do wanna apply the upates.

Just copy and paste your `user` folder to the latest release.

Watch out for the CHANGELOG to see if yor are required to migrate `user/config`.
Watch out for the CHANGELOG to see if yor are required to migrate `user/config` or other places.

## ❓ Issues / Problems / Questions

Expand All @@ -140,8 +130,6 @@ To see who else are using QWER, please check [Github-Topics: svelte-qwer](https:

## 🎉 Support

<a href="https://www.producthunt.com/posts/qwer?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-qwer" target="_blank" rel="noreferrer noopener"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=356641&theme=light" alt="QWER - ✒︎&#0032;Simply&#0032;Awesome&#0032;Blog&#0032;Starter&#0032;built&#0032;with&#0032;Svelte&#0032;and&#0032;❤ | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>

<div class="flex" style="display:inline-block; font-size: 24px; --un-bg-opacity: 1; background-color: rgba(255, 221, 0); border-radius: 0.5rem; padding: 12px 18px; border: 2px solid;">
<a class="flex" href="https://www.buymeacoffee.com/kwchang0831" style="color: black;" >
<span>🥓</span>
Expand Down

0 comments on commit a767913

Please sign in to comment.