From c833a824b67ff49bda49041232205c525e5e8350 Mon Sep 17 00:00:00 2001 From: southerntofu Date: Wed, 1 Apr 2020 17:01:29 +0200 Subject: [PATCH] Add credits and reorganize TODO --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 9a1dd68..1273734 100644 --- a/README.md +++ b/README.md @@ -268,7 +268,7 @@ The current language's index page lies in {{ macros::i18n_page(path="_index.md") #### Structure -index.html is the main template that gets rendered for everypage. It defines the current language and renders the global page skeleton accordingly. In addition, it defines a few blocks that are overriden by children templates: +index.html is the main template that gets rendered for everypage. It renders the global page skeleton according to the language requested. In addition, it defines a few blocks that are overriden by children templates: - title: the raw page title - main: the main content @@ -307,8 +307,6 @@ You can then summon this menu like this: {{ widgets::menu(content="menu.md") }} ``` -If a `lang` variable is defined in the current context, the macro will automatically find the localized page for the menu. - #### Translations in templates ##### Localized string @@ -319,7 +317,7 @@ If you want to use a translation string defined in the translations section of t {{ trans(key="readmore", lang=lang) }} ``` -The lang variable is conveniently set for you at the top of index.html template so all templates which extend index.html should have it. +Conveniently, the `lang` variable is automatically set by Zola in most contexts. ##### Localized path @@ -330,8 +328,6 @@ In case you need to interact with a localized page, you will need to replace the {{ widgets::i18n_path(path="@/blog/_index.md") }} ``` -If the `lang` variable is set in the context, the corresponding path will be returned. - ##### Localized page content If you wish to directly extract the contents of a localized page, without any regards to its frontmatter, you can use the i18n_content macro: @@ -341,8 +337,6 @@ If you wish to directly extract the contents of a localized page, without any re {{ widgets::i18n_content(path="@/blog/_index.md") }} ``` -If the `lang` variable is set in the context, the corresponding page's content will be returned. - ##### Localized URL If you need to get the localized URI for path on the website, you can use the i18n_url macro which acts as a wrapper around the [get_url](https://www.getzola.org/documentation/templates/overview/#get-url) function: @@ -352,8 +346,6 @@ If you need to get the localized URI for path on the website, you can use the i1 RSS ``` -If the `lang` variable is set in the context, the corresponding URL will be returned. - # TODO If something is missing for you, please open an issue. @@ -367,12 +359,23 @@ If something is missing for you, please open an issue. - [x] blogposts - [x] other strings in the templates - [x] localized RSS links - - [ ] links to navigate between languages + - [x] links to navigate between languages - [x] support generic default_language (not en by default) + - [ ] localized title/description for RSS +- [ ] README + - [x] setup/configuration guide + - [x] contribution guide (edition, translation, webdesign) + - [x] credits + - [ ] quickstart guide for git - [ ] other - [x] ASCII banner does not overflow - - [x] write setup/configuration guide - - [x] reference water.css semantic styling - - [ ] RSS (missing localized title and description) - - [x] hacking guides for: edition, translation, webdesign - - [ ] reference quickstart guide for git + - [ ] translation bubble fits nicely on all sizes + +# Credits + +This libre website would not have been possible without: + +- [water.css](https://github.com/kognise/water.css) for the base stylesheet +- [Zola](https://getzola.org) static site generator (SSG) +- [Gitea](https://gitea.io) forge and [git](https://git-scm.com/) VCS +- [SASS](https://sass-lang.com/) language for our stylesheets