From 3f2e45601aa4154f5d45119017b4f53cec3e0c98 Mon Sep 17 00:00:00 2001 From: welpo Date: Fri, 8 Sep 2023 17:00:32 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9B=20docs(ToC):=20fix=20broken=20code?= =?UTF-8?q?=20block?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 ++++++++++--- content/blog/toc.ca.md | 4 +++- content/blog/toc.es.md | 4 +++- content/blog/toc.md | 4 +++- 4 files changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 61e7a92..45afa9a 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,8 @@ tabi has a perfect score on Google's Lighthouse audit: ## Features -- [X] Multi-language support. +- [X] Full multi-language support. Set as many languages to your site as you wish. +- [X] Single non-English language support. Set your entire site to Chinese, Spanish, French, Russian… or any [other supported language](/i18n). - [X] Dark and light themes. Defaults to the OS setting, with a switcher in the navigation bar. - [X] Support for [comments using giscus, utterances, Hyvor Talk, or Isso](https://welpo.github.io/tabi/blog/comments/). - [X] Perfect Lighthouse score (Performance, Accessibility, Best Practices and SEO). @@ -112,7 +113,9 @@ The content outside the front matter will be rendered between the header title a - set the title and taxonomies for each language; - add the `language_name.{code}` in `[extra]`. This is the text shown in the language switcher. -See [these lines in the provided `config.toml`](https://github.com/welpo/tabi/blob/main/config.toml#L22-L134) for an example. +TODO: Mention i18n/ + +See [these lines in the provided `config.toml`](https://github.com/welpo/tabi/blob/main/config.toml#L21-L43) for an example. You will need an `_index.{language_code}.md` per language for each section (e.g. /blog or /projects) that you want to enable in that language. @@ -130,7 +133,11 @@ This theme was inspired by: ## Contributing -Please do! Take a look at the [Contributing Guidelines](/CONTRIBUTING.md) to learn more. +Please do! + +TODO: we appreciate bug reports, translations, documentation improvements, and pull requests. + +Take a look at the [Contributing Guidelines](/CONTRIBUTING.md) to learn more. ## License diff --git a/content/blog/toc.ca.md b/content/blog/toc.ca.md index c3fdf71..bc369ca 100644 --- a/content/blog/toc.ca.md +++ b/content/blog/toc.ca.md @@ -1,7 +1,7 @@ +++ title = "Taula de contingut" date = 2022-11-01 -updated = 2023-08-14 +updated = 2023-09-08 description = "Una publicació que mostra la taula de contingut opcional i la seva configuració." [taxonomies] @@ -52,11 +52,13 @@ El codi per aconseguir-ho: Si col·loques la TdC en un lloc diferent del predeterminat i li afegeixes un capçalera, segurament voldràs ocultar aquest capçalera de la TdC (consulta la [secció per ocultar capçaleres](#ocultant-capcaleres-de-la-tdc)). Pots fer-ho així: ```markdown,hl_lines=06 11-13 ++++ title = "El títol del teu post" date = 2034-01-11 [extra] toc_ignore_pattern = "^(Taula de contingut)" ++++ Aquí va algun text introductori. diff --git a/content/blog/toc.es.md b/content/blog/toc.es.md index f5d3f3a..4f985a9 100644 --- a/content/blog/toc.es.md +++ b/content/blog/toc.es.md @@ -1,7 +1,7 @@ +++ title = "Tabla de contenido" date = 2022-11-01 -updated = 2023-08-14 +updated = 2023-09-08 description = "Una publicación que muestra la tabla de contenido opcional así como su configuración." [taxonomies] @@ -52,11 +52,13 @@ El código para lograr esto: Si colocas la TdC en algún lugar distinto al predeterminado y le añades un encabezado, seguramente quieras ocultar dicho encabezado de la TdC (consulta la [sección para ocultar encabezados](#ocultando-encabezados-de-la-tdc)). Puedes lograrlo así: ```markdown,hl_lines=06 11-13 ++++ title = "El título de tu post" date = 2034-01-11 [extra] toc_ignore_pattern = "^(Tabla de contenido)" ++++ Aquí va algún texto introductorio. diff --git a/content/blog/toc.md b/content/blog/toc.md index 0d74daf..26915f1 100644 --- a/content/blog/toc.md +++ b/content/blog/toc.md @@ -1,7 +1,7 @@ +++ title = "Table of Contents" date = 2022-11-01 -updated = 2023-08-14 +updated = 2023-09-08 description = "A post showcasing the optional Table of Contents and its options." [taxonomies] @@ -51,11 +51,13 @@ The code to achieve this: If you set a custom position and a custom header for the ToC, you'll probably want to hide it (see the [section below](#hiding-headers-from-the-toc)) like this: ```markdown,hl_lines=06 11-13 ++++ title = "Your Post's Title" date = 2034-01-11 [extra] toc_ignore_pattern = "^(Table of Contents)" ++++ Here goes some introductory text.