📝 docs: add tabi-start integration (#441)

.github/PULL_REQUEST_TEMPLATE.md

@@ -58,6 +58,7 @@ If you need help, please ask! -->
 - [ ] I have verified the accessibility of my changes
 - [ ] I have tested all possible scenarios for this change
 - [ ] I have updated `theme.toml` with a sane default for the feature
+- [ ] I have updated `config.toml` in [tabi-start](https://github.com/welpo/tabi-start)
 - [ ] I have made corresponding changes to the documentation:
   - [ ] Updated `config.toml` comments
   - [ ] Updated `theme.toml` comments

README.md

@@ -18,9 +18,12 @@
         <img src="https://img.shields.io/badge/clean_commits-git--sumi-0?style=flat-square&labelColor=202b2d&color=087e96" alt="Clean commits"></a>
 </p>
 
-# tabi
+# 🌱 tabi
 
-A fast, lightweight, and modern [Zola](https://www.getzola.org) theme with multi-language support. It aims to be a personal page and home to blog posts.
+An accessible [Zola](https://www.getzola.org) theme with [search](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#search), [multi-language support](https://welpo.github.io/tabi/blog/faq-languages/), [optional JavaScript](https://welpo.github.io/tabi/blog/javascript/), a perfect Lighthouse score, and [comprehensive documentation](https://welpo.github.io/tabi). Crafted for personal websites and blogs.
+
+> [!TIP]
+> Want to start blogging right away? Use the [tabi-start template](https://github.com/welpo/tabi-start) to get a complete site up and running in minutes.
 
 See a live preview (and the theme's documentation) [here](https://welpo.github.io/tabi).
 
@@ -71,6 +74,11 @@ tabi has a perfect score on Google's Lighthouse audit:
 
 ## Installation
 
+> [!NOTE]
+> The fastest way to create a new site is to use the [tabi-start template](https://github.com/welpo/tabi-start). This gives you a complete blog setup with all the essential configuration ready to go.
+
+### Manual installation
+
 To add tabi to you existing Zola site:
 
 0. Initialize a Git repository in your project directory (if you haven't already):

config.toml

@@ -1,14 +1,14 @@
 base_url = "https://welpo.github.io/tabi"
 title = "~/tabi"
-description = "tabi is a fast, lightweight, and modern Zola theme with multi-language support, optional JavaScript, and a perfect Lighthouse score."
+description = "tabi is an accessible Zola theme with search, multi-language support, optional JavaScript, a perfect Lighthouse score, and comprehensive documentation. Crafted for personal websites and blogs."
 author = "welpo"
 generate_feeds = true
 compile_sass = true
 minify_html = true
 build_search_index = true
 
-# To translate the entire theme, there must be a file with the same ISO 639-1
-# (or IETF BCP 47) Code in the `i18n` folder of your site or the tabi theme
+# To translate the entire theme, there must be a file with the same language code
+# in the `i18n` folder of your site or the tabi theme.
 # For example, "i18n/fr.toml" for French or "i18n/zh-Hans.toml" for Simplified Chinese.
 # Otherwise the theme will be in English.
 # See https://welpo.github.io/tabi/blog/faq-languages/ for more details.
@@ -50,14 +50,14 @@ skip_anchor_prefixes = [
 
 [languages.es]
 title = "~/tabi"
-description = "tabi es un tema de Zola rápido, liviano y moderno con JavaScript opcional y una puntuación perfecta en Lighthouse."
+description = "tabi es un tema accesible para Zola con búsqueda, soporte multilingüe, JavaScript opcional, una puntuación perfecta en Lighthouse y documentación exhaustiva. Diseñado para sitios web y blogs personales."
 generate_feeds = true
 taxonomies = [{name = "tags", feed = true}]
 build_search_index = true
 
 [languages.ca]
 title = "~/tabi"
-description = "tabi és un tema de Zola ràpid, lleuger i modern amb JavaScript opcional i una puntuació perfecta a Lighthouse."
+description = "tabi és un tema accessible per a Zola amb cerca, suport multilingüe, JavaScript opcional, una puntuació perfecta a Lighthouse i documentació exhaustiva. Dissenyat per a llocs web i blogs personals."
 generate_feeds = true
 taxonomies = [{name = "tags", feed = true}]
 

content/_index.ca.md

@@ -12,4 +12,4 @@ show_projects_first = false
 social_media_card = "ca.jpg"
 +++
 
-tabi és un tema de [Zola](https://www.getzola.org) ràpid, lleuger i modern. Té com a objectiu ser una pàgina personal i llar d'entrades de blog. Compta amb una puntuació perfecta de Lighthouse, disseny responsive, tema fosc i clar, shortcodes personalitzats i molt més.
+tabi és un tema accessible per a Zola amb [cerca](https://welpo.github.io/tabi/ca/blog/mastering-tabi-settings/#cerca), [suport multilingüe](https://welpo.github.io/tabi/ca/blog/faq-languages/), [JavaScript opcional](https://welpo.github.io/tabi/ca/blog/javascript/), una puntuació perfecta a Lighthouse i [documentació exhaustiva](https://welpo.github.io/tabi/ca). Dissenyat per a llocs web i blogs personals.

content/_index.es.md

@@ -12,4 +12,4 @@ show_projects_first = false
 social_media_card = "es.jpg"
 +++
 
-tabi es un tema de [Zola](https://www.getzola.org) rápido, ligero y moderno. Su objetivo es ser una página personal y hogar para publicaciones de blogs. Cuenta con una puntuación perfecta en Lighthouse, diseño responsive, tema oscuro y claro, shortcodes personalizados y mucho más.
+tabi es un tema accesible para [Zola](https://www.getzola.org) con [búsqueda](https://welpo.github.io/tabi/es/blog/mastering-tabi-settings/#busqueda), [soporte multilingüe](https://welpo.github.io/tabi/es/blog/faq-languages/), [JavaScript opcional](https://welpo.github.io/tabi/es/blog/javascript/), una puntuación perfecta en Lighthouse y [documentación exhaustiva](https://welpo.github.io/tabi/es). Diseñado para sitios web y blogs personales.

content/_index.md

@@ -12,4 +12,4 @@ show_projects_first = false
 social_media_card = "index.jpg"
 +++
 
-tabi is a fast, lightweight, and modern [Zola](https://www.getzola.org) theme. It aims to be a personal page and home to blog posts. It features a perfect Lighthouse score, responsive design, dark and light themes, custom shortcodes, and much more.
+tabi is an accessible [Zola](https://www.getzola.org) theme with [search](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#search), [multi-language support](https://welpo.github.io/tabi/blog/faq-languages/), [optional JavaScript](https://welpo.github.io/tabi/blog/javascript/), a perfect Lighthouse score, and [comprehensive documentation](https://welpo.github.io/tabi). Crafted for personal websites and blogs.

content/blog/mastering-tabi-settings/index.ca.md

@@ -1,7 +1,7 @@
 +++
 title = "Domina la configuració de tabi: guia completa"
 date = 2023-09-18
-updated = 2024-11-16
+updated = 2024-11-27
 description = "Descobreix les múltiples maneres en què pots personalitzar tabi."
 
 [taxonomies]
@@ -371,7 +371,7 @@ quick_navigation_buttons = true
 - `show_reading_time = false` amaga el temps estimat de lectura.
 - `quick_navigation_buttons = true` mostra els botons de navegació ràpida.
 
-Al costat del fitxer `_index.md`, pots crear un fitxer per a cada projecte. Per exemple, aquest és el bloc de metadades per a la pàgina del projecte [tabi](/ca/projects/tabi/):
+Al costat del fitxer `_index.md`, pots crear un fitxer per a cada projecte. Per exemple, aquest és el bloc de metadades per a la pàgina del projecte [tabi](@/projects/tabi/index.ca.md):
 
 ```toml
 title = "tabi"

content/blog/mastering-tabi-settings/index.es.md

@@ -1,7 +1,7 @@
 +++
 title = "Domina la configuración de tabi: guía completa"
 date = 2023-09-18
-updated = 2024-11-16
+updated = 2024-11-27
 description = "Descubre las múltiples maneras en que puedes personalizar tabi."
 
 [taxonomies]
@@ -371,7 +371,7 @@ quick_navigation_buttons = true
 - `show_reading_time = false` oculta el tiempo estimado de lectura.
 - `quick_navigation_buttons = true` muestra los botones de navegación rápida.
 
-Junto al archivo `_index.md`, puedes crear un archivo para cada proyecto. Por ejemplo, este es el bloque de metadatos para la página del proyecto [tabi](/es/projects/tabi/):
+Junto al archivo `_index.md`, puedes crear un archivo para cada proyecto. Por ejemplo, este es el bloque de metadatos para la página del proyecto [tabi](@/projects/tabi/index.es.md):
 
 ```toml
 title = "tabi"

content/blog/mastering-tabi-settings/index.md

@@ -1,7 +1,7 @@
 +++
 title = "Mastering tabi Settings: A Comprehensive Guide"
 date = 2023-09-18
-updated = 2024-11-16
+updated = 2024-11-27
 description = "Discover the many ways you can customise your tabi site."
 
 [taxonomies]
@@ -376,11 +376,11 @@ quick_navigation_buttons = true
 - `show_reading_time = false` hides the [reading time](#reading-time).
 - `quick_navigation_buttons = true` shows the [quick navigation buttons](#quick-navigation-buttons) are shown.
 
-Alongside the `_index.md` file, you can create a file for each project. For example, this is the front matter for the [tabi project page](/projects/tabi/):
+Alongside the `_index.md` file, you can create a file for each project. For example, this is the front matter for the [tabi project page](@/projects/tabi/index.md):
 
 ```toml
 title = "tabi"
-description = "A fast, lightweight, and modern Zola theme with multi-language support."
+description = "A feature-rich modern Zola theme with first-class multi-language support."
 weight = 1
 
 [extra]

theme.toml

@@ -1,5 +1,5 @@
 name = "tabi"
-description = "A fast, lightweight, and modern Zola theme with multi-language support, optional JavaScript, and a perfect Lighthouse score"
+description = "tabi is an accessible Zola theme with search, multi-language support, optional JavaScript, a perfect Lighthouse score, and comprehensive documentation. Crafted for personal websites and blogs."
 license = "MIT"
 homepage = "https://github.com/welpo/tabi"