From a767913c7bd44b5b2281d94c90aea0323be7ef6e Mon Sep 17 00:00:00 2001 From: kwchang0831 <88667293+kwchang0831@users.noreply.github.com> Date: Sun, 11 Sep 2022 14:50:35 +0800 Subject: [PATCH] :memo: doc: update README --- README-zh.md | 58 +++++++++++++++++++++------------------------------- README.md | 54 +++++++++++++++++++----------------------------- 2 files changed, 44 insertions(+), 68 deletions(-) diff --git a/README-zh.md b/README-zh.md index 085c72e..712d03a 100644 --- a/README-zh.md +++ b/README-zh.md @@ -1,30 +1,20 @@ -
-
-https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/qwer.webp -
-
+

English | 中文

+

QWER

+

-✒︎ 使用 SvelteKit 與 ❤ 打造的部落格生成器,簡單好用。 +使用 SvelteKit 精心打造的部落格生成器

-

-Readme -Language + +

Language GitHub Readme -Q&A -

+Q&A

-

-svelte-QWER -QWER -

+

svelte-QWER +QWER

-
- -

-PAGESPEED -

+

PAGESPEED

## 🎉 馬上嘗試看看 QWER @@ -32,9 +22,9 @@ npx degit kwchang0831/svelte-QWER my-blog ``` -

https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp

+

https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/preview.webp


-

https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp

+

https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp

## ⚡️ 用法 @@ -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 引擎。 @@ -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` 或其他地方進行更新與調整。 ## ❓ 有任何使用上的問題 @@ -138,8 +128,6 @@ npx degit kwchang0831/svelte-QWER my-blog ## 🎉 支持 -QWER - ✒︎ Simply Awesome Blog Starter built with Svelte and ❤ | Product Hunt -
🥓 diff --git a/README.md b/README.md index 055c43e..5bc495f 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,20 @@ -
-
-https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/qwer.webp -
-
+

English | 中文

+

QWER

+

-✒︎ Simply Awesome Blog Starter built with SvelteKit and ❤ +Simply Awesome Blog Starter built with SvelteKit and

-

-Readme -Language + +

Language GitHub Readme -Q&A -

+Q&A

-

-svelte-QWER -QWER -

+

svelte-QWER +QWER

-
- -

-PAGESPEED -

+

PAGESPEED

## 🎉 Try it out @@ -32,9 +22,9 @@ npx degit kwchang0831/svelte-QWER my-blog ``` -

https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp

+

https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp


-

https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp

+

https://raw.githubusercontent.com/kwchang0831/svelte-QWER/main/user/assets/mobile-preview.webp

## ⚡️ Usage @@ -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). @@ -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 @@ -140,8 +130,6 @@ To see who else are using QWER, please check [Github-Topics: svelte-qwer](https: ## 🎉 Support -QWER - ✒︎ Simply Awesome Blog Starter built with Svelte and ❤ | Product Hunt -
🥓