From 72b3a064551cbe0a4ff1317a5eaf6d19803f50b5 Mon Sep 17 00:00:00 2001 From: krmanik <12841290+krmanik@users.noreply.github.com> Date: Wed, 14 Feb 2024 21:28:10 +0800 Subject: [PATCH] update docs --- README.md | 79 +++++++++++++++++++++++++----- docs/customization/change-prefs.md | 2 + docs/gettings-started/download.md | 75 +++++++++++++++++++++++++--- docs/gettings-started/install.md | 5 -- docs/styles.module.css | 10 +++- src/pages/create.module.css | 5 -- src/pages/create.tsx | 5 +- src/pages/index.module.css | 4 +- 8 files changed, 150 insertions(+), 35 deletions(-) delete mode 100644 src/pages/create.module.css diff --git a/README.md b/README.md index 402ca90..cf40aa5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Anki xiě hànzì (写汉字） +# Anki xiě hànzì (写汉字) [Anki-xiehanzi](https://krmanik.github.io/Anki-xiehanzi) @@ -7,19 +7,11 @@ Learn, read, write and practice Mandarin by drawing strokes in [Anki Desktop](ht # Quick Start -Download HSK Anki apkg file for Anki Desktop, AnkiDroid or AnkiMobile +Download HSK Anki apkg file for [Anki Desktop](https://apps.ankiweb.net/), [AnkiDroid](https://play.google.com/store/apps/details?id=com.ichi2.anki) or [AnkiMobile](https://apps.apple.com/us/app/ankimobile-flashcards/id373493387) -**Before importing Anki Deck please make backups with scheduling information.** - -## New HSK 3.0 Mandarin Chinese Deck -### Download from AnkiWeb (HSK 1 - HSK 9) -[Anki xiehanzi HSK 3.0: Learn Mandarin by drawing strokes](https://ankiweb.net/shared/info/239300382) +[Download Anki Deck](https://ankiweb.net/shared/info/1351435439) -### Download from GitHub (HSK 1 - HSK 9) -[Anki xiehanzi HSK 3.0](https://github.com/krmanik/Anki-xiehanzi/releases) - -## Download previous versions of deck from here -[Download previous version](https://krmanik.github.io/Anki-xiehanzi/docs/gettings-started/download) +**Before importing Anki Deck please make backups with scheduling information.** # Features - Night mode @@ -39,6 +31,69 @@ Download HSK Anki apkg file for Anki Desktop, AnkiDroid or AnkiMobile Note: Some changes will get reflect from next card. +## There are five types of Anki-xiehanzi deck. + +### Type 1 (Recommended) + +The deck contains separate decks for each types. +1. Learn Strokes order of characters +2. Learn Meaning of characters +3. Learn Pinyin or Zhuyin of characters +4. Learn Pronunciation using audio and Pinyin or Zhuyin + +> The deck is sorted in frequency order. + +[Download](https://ankiweb.net/shared/info/1351435439) + +### Type 2 (Recommended) + +The deck contains five card types in each HSK level notes. +1. Learn Strokes order of characters +2. Learn Meaning of characters +3. Learn Pinyin or Zhuyin of characters +4. Learn Pronunciation using audio and Pinyin or Zhuyin +5. Learn Tone marks of characters + +> The deck is sorted in frequency order. + +[Download](https://ankiweb.net/shared/info/239300382) + +### Type 3 + +The deck contains five card types, but decks are sorted in alphabetical pinyin order. +1. Learn strokes order of characters +2. Learn meaning of characters +3. Learn Pinyin or Zhuyin of characters +4. Learn pronunciation using audio and Pinyin or Zhuyin +5. Learn tone marks of characters + +> This deck is **not** sorted in frequency order. + +[Download](https://ankiweb.net/shared/info/1063372083) + +### Type 4 + +The deck contains notes with single note type
+- Front side contains pinyin and meaning. +- Back side contains writing component. + +> This deck is **not** sorted in frequency order. + +[Download](https://ankiweb.net/shared/info/536858343) + +### Type 5 +HSK 2.0 deck + +> This deck is **not** sorted in frequency order. + +[Download](https://ankiweb.net/shared/info/119943820) + +## Create + +Create Anki-xiehanzi deck from simplified word, paragraph and file containing simplified characters. + +https://krmanik.github.io/Anki-xiehanzi/create + ## Docs View [docs](https://krmanik.github.io/Anki-xiehanzi/docs/intro) diff --git a/docs/customization/change-prefs.md b/docs/customization/change-prefs.md index 40c0aaa..55ec178 100644 --- a/docs/customization/change-prefs.md +++ b/docs/customization/change-prefs.md @@ -2,6 +2,8 @@ sidebar_position: 1 --- +import styles from '../styles.module.css'; + # Change Preferences ![](../../static/img/options.png) diff --git a/docs/gettings-started/download.md b/docs/gettings-started/download.md index 3dc5e9f..a273eb5 100644 --- a/docs/gettings-started/download.md +++ b/docs/gettings-started/download.md @@ -10,8 +10,45 @@ import styles from '../styles.module.css'; First of all download the latest version xiehanzi decks from Ankiweb or GitHub releases page.
**Note:- Before importing Anki Deck please make backups with scheduling information.** -## New HSK 3.0 Mandarin Chinese Deck (Recommended) -The deck contains notes with five note types to practice meaning, pinyin or zhuyin, audio, tone marks and writing of characters **in** frequency order. +### There are five types of Anki-xiehanzi deck. + +### Type 1 (Recommended) + +The deck contains separate decks for each types. +1. Learn Strokes order of characters +2. Learn Meaning of characters +3. Learn Pinyin or Zhuyin of characters +4. Learn Pronunciation using audio and Pinyin or Zhuyin + +*The deck is sorted in frequency order.* + +
+ + Download from Ankiweb + +
+ +
+ + Download from GitHub + +
+ +### Type 2 (Recommended) + +The deck contains five card types in each HSK level notes. +1. Learn Strokes order of characters +2. Learn Meaning of characters +3. Learn Pinyin or Zhuyin of characters +4. Learn Pronunciation using audio and Pinyin or Zhuyin +5. Learn Tone marks of characters + +*The deck is sorted in frequency order.* +
-## Anki xiehanzi - HSK 3.0 -The deck contains notes with five note types to practice meaning, pinyin or zhuyin, audio, tone marks and writing of characters **not in** frequency order. +### Type 3 + +The deck contains five card types, but decks are sorted in alphabetical pinyin order. +1. Learn strokes order of characters +2. Learn meaning of characters +3. Learn Pinyin or Zhuyin of characters +4. Learn pronunciation using audio and Pinyin or Zhuyin +5. Learn tone marks of characters + +*The deck is not sorted in frequency order.* +
-## xiehanzi - HSK 3.0 -The deck contains notes with single note type - front side contains pinyin and meaning and back side contains writing component. +### Type 4 + +The deck contains notes with single note type
+- Front side contains pinyin and meaning. +- Back side contains writing component. + +*The deck is not sorted in frequency order.*
-## HSK2.0 +### Type 5 +HSK 2.0 deck + +*The deck is not sorted in frequency order.* +
+ +## Create + +Create Anki-xiehanzi deck from simplified word, paragraph and file containing simplified characters. + +https://krmanik.github.io/Anki-xiehanzi/create diff --git a/docs/gettings-started/install.md b/docs/gettings-started/install.md index e26b78d..4eba2d2 100644 --- a/docs/gettings-started/install.md +++ b/docs/gettings-started/install.md @@ -46,9 +46,4 @@ style={{paddingLeft:"8px"}}> src="https://raw.githubusercontent.com/krmanik/Anki-Android/main/docs/graphics/logos/amazon-badge.png"/> - - Get it on Huawei app gallery - - \ No newline at end of file diff --git a/docs/styles.module.css b/docs/styles.module.css index f8456b7..b5641b7 100644 --- a/docs/styles.module.css +++ b/docs/styles.module.css @@ -10,4 +10,12 @@ .buttons { display: inline-flex; -} \ No newline at end of file +} + +p { + margin: 0; +} + +img { + height: 80vh; +} diff --git a/src/pages/create.module.css b/src/pages/create.module.css deleted file mode 100644 index 38788a8..0000000 --- a/src/pages/create.module.css +++ /dev/null @@ -1,5 +0,0 @@ -ul, -ol { - margin: unset; - padding: unset; -} diff --git a/src/pages/create.tsx b/src/pages/create.tsx index 9010a6c..71233e7 100644 --- a/src/pages/create.tsx +++ b/src/pages/create.tsx @@ -30,7 +30,6 @@ import Layout from "@theme/Layout"; import CONSTANTS from "../dict/contants"; import DICT from "../dict/dict"; import pinzhu from "../dict/pinyinzhuyin"; -import create_styles from "./create.module.css"; import styles from "./index.module.css"; import { MsEdgeTTS, OUTPUT_FORMAT } from "msedge-tts"; @@ -283,7 +282,7 @@ export default function CreateDeck(): JSX.Element { const [selectWord, setSelectWord] = useState(null); const [rowClick, setRowClick] = useState(true); - useEffect(() => { + useEffect(() => { DICT.loadDict(); setupSql(); init( @@ -914,7 +913,7 @@ for (var _hide of hideList) {

Enter Chinese Characters

-
+