{"id":15147176,"url":"https://github.com/welpo/tabi","last_synced_at":"2025-04-12T17:38:26.794Z","repository":{"id":65656329,"uuid":"596604603","full_name":"welpo/tabi","owner":"welpo","description":"An accessible Zola theme with search, multi-language support, optional JavaScript, a perfect Lighthouse score, and comprehensive documentation. Crafted for personal websites and blogs.","archived":false,"fork":false,"pushed_at":"2025-04-10T19:10:04.000Z","size":34442,"stargazers_count":178,"open_issues_count":11,"forks_count":62,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-10T20:38:43.203Z","etag":null,"topics":["accessible","blog-theme","catppuccin","dark-theme","elastic","elasticlunr","giscus","hyvor-talk","isso-comments","local-search","multilanguage-support","no-javascript","offline-search","static-site","tabi","utterances","zola","zola-theme"],"latest_commit_sha":null,"homepage":"https://welpo.github.io/tabi/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/welpo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"welpo"}},"created_at":"2023-02-02T14:51:12.000Z","updated_at":"2025-04-10T19:09:41.000Z","dependencies_parsed_at":"2024-01-03T02:04:53.638Z","dependency_job_id":"16b84ee2-29cb-4d32-b846-fd1920c08e6c","html_url":"https://github.com/welpo/tabi","commit_stats":{"total_commits":824,"total_committers":31,"mean_commits":"26.580645161290324","dds":0.08616504854368934,"last_synced_commit":"66239bee016406c87a227b685eb70a464546e199"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welpo%2Ftabi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welpo%2Ftabi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welpo%2Ftabi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welpo%2Ftabi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/welpo","download_url":"https://codeload.github.com/welpo/tabi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248606861,"owners_count":21132428,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessible","blog-theme","catppuccin","dark-theme","elastic","elasticlunr","giscus","hyvor-talk","isso-comments","local-search","multilanguage-support","no-javascript","offline-search","static-site","tabi","utterances","zola","zola-theme"],"created_at":"2024-09-26T12:23:12.429Z","updated_at":"2025-04-12T17:38:26.772Z","avatar_url":"https://github.com/welpo.png","language":"JavaScript","funding_links":["https://github.com/sponsors/welpo"],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"CONTRIBUTING.md#pull-requests\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-0?style=flat-square\u0026labelColor=202b2d\u0026color=087e96\" alt=\"PRs welcome\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/welpo/tabi/graphs/contributors\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/contributors/welpo/tabi?style=flat-square\u0026labelColor=202b2d\u0026color=087e96\" alt=\"Contributors\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/welpo/tabi/forks\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/forks/welpo/tabi?style=flat-square\u0026labelColor=202b2d\u0026color=087e96\" alt=\"Forks\"\u003e\u003c/a\u003e\n    \u003ca hfref=\"https://github.com/welpo/tabi/commits/main/\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/last-commit/welpo/tabi?style=flat-square\u0026labelColor=202b2d\u0026color=087e96\" alt=\"Last commit\"\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://github.com/welpo/tabi/releases\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/v/release/welpo/tabi?style=flat-square\u0026labelColor=202b2d\u0026color=087e96\" alt=\"Latest release\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://welpo.github.io/tabi/blog/mastering-tabi-settings/\"\u003e\n        \u003cimg src=\"https://img.shields.io/website?url=https%3A%2F%2Fwelpo.github.io%2Ftabi\u0026style=flat-square\u0026label=docs\u0026labelColor=202b2d\" alt=\"Documentation\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/welpo/tabi/blob/main/LICENSE\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/welpo/tabi?style=flat-square\u0026labelColor=202b2d\u0026color=087e96\" alt=\"License\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/welpo/git-sumi\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/clean_commits-git--sumi-0?style=flat-square\u0026labelColor=202b2d\u0026color=087e96\" alt=\"Clean commits\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://isitmaintained.com/project/welpo/tabi\"\u003e\n        \u003cimg src=\"https://isitmaintained.com/badge/resolution/welpo/tabi.svg\" alt=\"Average time to resolve an issue\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://isitmaintained.com/project/welpo/tabi\"\u003e\n        \u003cimg src=\"https://isitmaintained.com/badge/open/welpo/tabi.svg\" alt=\"Percentage of issues still open\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# 🌱 tabi\n\nAn 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.\n\n\u003e [!TIP]\n\u003e 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.\n\nSee a live preview (and the theme's documentation) [here](https://welpo.github.io/tabi).\n\nExplore the [Sites Using tabi section](#sites-using-tabi) to see real-world applications.\n\n\u003e tabi (旅, /\u003cspan title=\"/t/: 't' in 'sty'\"\u003et\u003c/span\u003e\u003cspan title=\"/ɐ/: a sound between 'a' in 'sofa' and 'u' in 'nut'\"\u003eɐ\u003c/span\u003e\u003cspan title=\"/ˈ/: primary stress mark, indicating that the following syllable is pronounced with greater emphasis\"\u003eˈ\u003c/span\u003e\u003cspan title=\"/b/: 'b' in 'cab'\"\u003eb\u003c/span\u003e\u003cspan title=\"/i/: 'i' in 'fleece'\"\u003ei\u003c/span\u003e/): Journey.\n\n![tabi](https://github.com/welpo/tabi/raw/main/light_dark_screenshot.png)\n\ntabi has a perfect score on Google's Lighthouse audit:\n\n![lighthouse](https://raw.githubusercontent.com/welpo/tabi/main/lighthouse_score.png)\n\n## Features\n\n- [X] [Set any language as default](https://welpo.github.io/tabi/blog/faq-languages/#how-do-i-set-a-default-language-for-my-site). Set your base site to Chinese, Spanish, French, Hindi… or any [other supported language](/i18n). The theme's interface will be translated accordingly.\n- [X] [Integration with remote repositories](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#git-repository-integration) on GitHub, GitLab, Gitea \u0026 Codeberg for commit history and showing the site source.\n- [X] [Series support](https://welpo.github.io/tabi/blog/series/) for creating sequential content like tutorials, courses, and multi-part stories.\n- [X] Dark and light themes. Defaults to the OS setting, with a switcher in the navigation bar.\n- [X] Thorough documentation. See [Mastering tabi Settings: A Comprehensive Guide](https://welpo.github.io/tabi/blog/mastering-tabi-settings/).\n- [X] Perfect Lighthouse score (Performance, Accessibility, Best Practices and SEO).\n- [X] [Comprehensive multi-language support](https://welpo.github.io/tabi/blog/faq-languages/#how-does-tabi-handle-multilingual-support). Add as many languages as you wish.\n- [X] Support for [comments using giscus, utterances, Hyvor Talk, or Isso](https://welpo.github.io/tabi/blog/comments/).\n- [X] Code syntax highlighting with colours based on [Catppuccin](https://github.com/catppuccin/catppuccin) Frappé.\n- [X] [Mermaid support](https://welpo.github.io/tabi/blog/shortcodes/#mermaid-diagrams) to create diagrams and charts with text.\n- [X] [Local search](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#search) with an accessible, multi-lingual interface.\n- [X] [Custom Twitter card](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-cards) and automatic Open Graph tags.\n- [X] [KaTeX](https://katex.org/) support for mathematical notation.\n- [X] [Stylized and human readable Atom feed](https://welpo.github.io/tabi/atom.xml).\n- [X] [Stylized and human readable sitemap](https://welpo.github.io/tabi/sitemap.xml).\n- [X] [Mail encoding](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#encoded-email) for spam protection.\n- [X] All JavaScript can be [fully disabled](https://welpo.github.io/tabi/blog/javascript/).\n- [X] [Customizable Table of Contents](https://welpo.github.io/tabi/blog/toc/).\n- [X] [Customizable secure headers](https://welpo.github.io/tabi/blog/security/).\n- [X] [Copy button for code blocks](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#copy-button-on-code-blocks).\n- [X] [Quick navigation buttons](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#quick-navigation-buttons).\n- [X] [Custom copyright notice](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#copyright).\n- [X] [Custom canonical URLs](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#canonical-url).\n- [X] [Custom shortcodes](https://welpo.github.io/tabi/blog/shortcodes/).\n- [X] [Customizable skins](https://welpo.github.io/tabi/blog/customise-tabi/).\n- [X] [Social media cards](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-cards).\n- [X] Responsive design.\n- [X] [Projects page](https://welpo.github.io/tabi/projects/).\n- [X] [Archive page](https://welpo.github.io/tabi/archive/).\n- [X] [Pinned posts](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#pinning-posts).\n- [X] [Social links](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-icons).\n- [X] [Tags](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#tags).\n\n## Installation\n\n\u003e [!NOTE]\n\u003e 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.\n\n### Manual installation\n\nTo add tabi to you existing Zola site:\n\n0. Initialize a Git repository in your project directory (if you haven't already):\n\n```\ngit init\n```\n\n1. Add the theme as a git submodule:\n\n```\ngit submodule add https://github.com/welpo/tabi.git themes/tabi\n```\n\nOr clone the theme into your themes directory:\n\n```\ngit clone https://github.com/welpo/tabi.git themes/tabi\n```\n\n### Required configuration\n\n2. Enable the theme in your `config.toml`:\n\n```\ntheme = \"tabi\"\n```\n\n3. Set a `title` in your `config.toml`:\n\n```\ntitle = \"Your Site Title\"\n```\n\n4. Configure code block highlighting in your `config.toml`:\n\n```toml\n[markdown]\nhighlight_code = true\nhighlight_theme = \"css\"\n```\n\n5. Create a `content/_index.md` file. This file controls how your home page looks and behaves. Choose one of the following options:\n\n   **Option A: Serve posts from `/`**:\n\n   ```\n   +++\n   title = \"Home\"\n   paginate_by = 5  # Show 5 posts per page.\n   +++\n   ```\n\n   - This will display posts in `content/` with pagination.\n\n   **Option B: Serve posts from a different path (e.g., `blog/`)**:\n\n   ```\n   +++\n   title = \"Home\"\n   # Note we're not setting `paginate_by` here.\n\n   [extra]\n   section_path = \"blog/_index.md\"  # Where to find your posts.\n   max_posts = 5  # Show 5 posts on the home page.\n   +++\n   ```\n\n    - This will display the latest 5 posts from the `blog/` section.\n    - Do not set `paginate_by` if you choose this option.\n    - Use the full path to the section's `_index.md` file. Using `section_path = \"blog/\"` will not work.\n\n\u003e [!WARNING]\n\u003e Do not set both `paginate_by` and `section_path` in `content/_index.md`.\n\u003e\n\u003e These settings are mutually exclusive and using both may result in no posts being displayed.\n\n6. If you want an introduction section (see screenshot above), add these lines to `content/_index.md`:\n\n```\n[extra]\nheader = {title = \"Hello! I'm tabi~\", img = \"img/main.webp\", img_alt = \"Your Name\" }\n```\n\nThe content outside the front matter will be rendered between the header title and the posts listing. In the screenshot above, it's the text that reads \"tabi is a fast, lightweight, and modern Zola theme…\".\n\n7. If you want a multilingual site, you will need to set up each language. In `config.toml`, set the title and taxonomies for each language, like:\n\n```toml\n[languages.es]\ntitle = \"~/tabi\"\ntaxonomies = [{name = \"tags\", feed = true}]\n```\n\nYou 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.\n\nThe same is true for individual posts, which should have the exact same name as the default language, with an extra `.{code}` before the extension (e.g. the Spanish version of `security.md` would be `security.es.md`).\n\nThis configuration allows the language switcher to take the user to the translation of the current URL. If a translation doesn't exist, the 404 page will be displayed, with an explanation in each language set in the config.\n\nTo learn more about multilingual support, see the [Frequently Asked Questions](https://welpo.github.io/tabi/blog/faq-languages/).\n\n### Updating tabi\n\nIf you added the theme as a git submodule, run:\n\n```bash\ngit submodule update --remote themes/tabi\n```\n\nIf you cloned it:\n\n```bash\ncd themes/tabi\ngit pull\n```\n\n## Sites using tabi\n\n| Website | Creator | Description  | Site Source   |\n| - | - | - | - |\n| [osc.garden](https://osc.garden) | Óscar Fernández ([welpo](https://github.com/welpo)) | Data science, psychology, and Zola | [Source](https://github.com/welpo/osc.garden) |\n| [sandip.live](https://sandip.live) | Sandip G ([sandman](https://github.com/sandman)) | Startups, tech and the good life | [Source](https://github.com/sandman/sandman.github.io) |\n| [seadve.github.io](https://seadve.github.io/) | Dave Patrick Caberto ([SeaDve](https://github.com/SeaDve/)) | Personal blog and portfolio with custom CSS | [Source](https://github.com/SeaDve/seadve.github.io) |\n| [mikufan.page](https://mikufan.page) | [Nadia](https://github.com/nyadiia) | Personal blog | [Source](https://github.com/nyadiia/mikufan.page) |\n| [tim-boettcher.online](https://tim-boettcher.online/) | [Tim Böttcher](https://codeberg.org/Tim-Boettcher/) | Insights and ramblings of a deafblind programmer | [Source](https://codeberg.org/Tim-Boettcher/tim-boettcher-online/) |\n| [www.richtman.au](https://www.richtman.au) | [Ariel Richtman](https://github.com/arichtman) | Personal tech blog | [Source](https://github.com/arichtman/www.richtman.au) |\n| [Ponderosa Games](https://ponderosagames.com/) | John Burak ([JVimes](https://github.com/jvimes)) | A friendly indie game company | \u0026mdash; |\n| [jmbhughes.com](https://jmbhughes.com/) | Marcus Hughes ([jmbhughes](https://github.com/jmbhughes)) | Personal blog | [Source](https://github.com/jmbhughes/jmbhughes.github.io) |\n| [szabolcs.me](https://szabolcs.me) | Szabolcs Fazekas ([szabolcsf](https://github.com/szabolcsf)) | Personal blog | [Source](https://github.com/szabolcsf/szabolcs.me) |\n| [Nizzlay](https://nizzlay.com) | Niels Gouman ([Nizzlay](https://github.com/Nizzlay)) | Personal blog | [Source](https://github.com/Nizzlay/nizzlay.com) |\n| [ZzMzaw's blog](https://zzmzaw.github.io/) | ZzMzaw ([ZzMzaw](https://github.com/ZzMzaw)) | Personal blog | [Source](https://github.com/ZzMzaw/zzmzaw.github.io) |\n| [idle-ti.me](https://idle-ti.me/) | Jérôme Ramette ([be-next](https://github.com/be-next)) | Personal blog | [Source](https://github.com/be-next/idle-ti.me) |\n| [tzinm.me](https://tzinm.me/) | [Tzinm](https://github.com/tzinm) | Personal blog | [Source](https://codeberg.org/tzinm/blog) |\n\nUsing tabi? Feel free to create a PR and add your site to this list.\n\n## Inspiration\n\nThis theme was inspired by:\n\n- [shadharon](https://github.com/syedzayyan/shadharon) — tabi started as a fork of [syedzayyan](https://github.com/syedzayyan)'s theme\n- [tailwind-nextjs-starter-blog](https://github.com/timlrx/tailwind-nextjs-starter-blog)\n- [abridge](https://github.com/Jieiku/abridge)\n\n## Support\n\nSomething not working? Have an idea? Let us know!\n\n- Questions? → [Start a discussion](https://github.com/welpo/tabi/discussions)\n- Found a bug? → [Report it here](https://github.com/welpo/tabi/issues/new?\u0026labels=bug\u0026template=2_bug_report.yml)\n- Feature request? → [Tell us more!](https://github.com/welpo/tabi/issues/new?\u0026labels=feature\u0026template=3_feature_request.yml)\n\n## Contributing\n\nPlease do! We appreciate bug reports, improvements to translations or documentation (however minor), feature requests…\n\nTake a look at the [Contributing Guidelines](/CONTRIBUTING.md) to learn more.\n\n## License\n\nThe code is available under the [MIT license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwelpo%2Ftabi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwelpo%2Ftabi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwelpo%2Ftabi/lists"}