From ccb339a13901c08e6edce11e3529f68eb0d55f3a Mon Sep 17 00:00:00 2001 From: "S. Kozyr" Date: Sat, 22 Jun 2024 13:05:54 +0300 Subject: [PATCH] Updated README.md according to latest changes. Signed-off-by: S. Kozyr --- README.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 8b5fb83d..f89815f0 100644 --- a/README.md +++ b/README.md @@ -48,34 +48,33 @@ Each MD page in `/faq/` has one or more taxonomy defined in header. E.g.: ```yaml taxonomies: - faq: ["Android"] + faq: ["app"] ``` Zola collects all such taxonomies: -| File | Taxonomy key | Taxonomy value | -| -------------------- | ------------ | -------------- | -| android-lags.md | `faq` | `Android` | -| android-logs.md | `faq` | `Android` | -| general-team.md | `faq` | `General` | -| general-bugreport.md | `faq` | `General` | -| ios-versions.md | `faq` | `iOS` | -| map-longtap.md | `faq` | `Map` | -| ... | ... | ... | +| File | Taxonomy key | Taxonomy value | +|-----------------------------------------| ------------ |----------------| +| map/can-find-position/index.md | `faq` | `map` | +| map/search-cannot-find-a-place/index.md | `faq` | `map` | +| editing/map-errors/index.md | `faq` | `editing` | +| app/crash/index.md | `faq` | `app` | +| text-to-speech-android-tts/index.md | `faq` | `tts` | +| ... | ... | ... | -After that Zola gets all values for `faq` taxonomy: `[General, Android, iOS, Map, ...]`. And generates pages: +After that Zola gets all values for `faq` taxonomy: `[app, map, editing, tts, ...]`. And generates pages: - For key `/faq/` with the list of values (see `templates/faq/list.html`) -- For each value `/faq/general`, `/faq/android`, etc. with the list of questions (see `templates/faq/single.html`) +- For each value `/faq/app`, `/faq/map`, etc. with the list of questions (see `templates/faq/single.html`) If you want to add new question then create .md file with header: ```yaml title: A full question that is the title of the page description: More detailed info with necessary keywords for better SEO -slug: the-url-of-the-page-that-can-be-localized-for-better-seo + taxonomies: - faq: ["General"] + faq: ["bookmarks"] extra: order: 40 ``` @@ -91,13 +90,16 @@ taxonomies = [ ] [languages.XX.translations] faq-menu-title = "{Translation of 'F.A.Q.' to a new language}" +faq_section_app = "App" +faq_section_bookmarks = "Bookmarks and Tracks" +faq_section_editing = "Map Editing" +faq_section_map = "Map" +faq_section_tts = "Voice Directions" ``` -**Limitation**: List of taxonomies at `/faq/` page is always alphabetical. So 'Android' is always the first, 'Bookmarks' is the second, 'General' is the third and so on. +**Limitation**: F.A.Q. categories are sorted alphabetically: "app", "bookmarks", "editing", "map", "tts". -**Limitation**: Questions at any F.A.Q. sub-page are sorted by file name. An `extra.order` variable in .md content files is used for sorting articles. - -**Limitation**: Each F.A.Q. sub-page has only a name. No description, no icon. Only name 'Android', or 'iOS', or 'Routing', etc. +**Limitation**: Each F.A.Q. category has only a name. No description, no icon. Only name 'App', or 'Bookmarks and Tracks', or 'Map Editing', etc. ## Contribution