Repository files navigation

An accessibleZola theme withsearch,multi-language support,optional JavaScript, a perfect Lighthouse score, andcomprehensive documentation. Crafted for personal websites and blogs.

See a live preview (and the theme's documentation)here.

Explore theSites Using tabi section to see real-world applications.

tabi (旅, /tɐˈbi/): Journey.

tabi has a perfect score on Google's Lighthouse audit:

• Set any language as default. Set your base site to Chinese, Spanish, French, Hindi… or anyother supported language. The theme's interface will be translated accordingly.
• Integration with remote repositories on GitHub, GitLab, Gitea & Codeberg for commit history and showing the site source.
• Series support for creating sequential content like tutorials, courses, and multi-part stories.
• Dark and light themes. Defaults to the OS setting, with a switcher in the navigation bar.
• Thorough documentation. SeeMastering tabi Settings: A Comprehensive Guide.
• Perfect Lighthouse score (Performance, Accessibility, Best Practices and SEO).
• Comprehensive multi-language support. Add as many languages as you wish.
• Support forcomments using giscus, utterances, Hyvor Talk, or Isso.
• Code syntax highlighting with colours based onCatppuccin Frappé.
• Mermaid support to create diagrams and charts with text.
• Local search with an accessible, multi-lingual interface.
• Custom Twitter card and automatic Open Graph tags.
• KaTeX support for mathematical notation.
• Stylized and human readable Atom feed.
• Stylized and human readable sitemap.
• Mail encoding for spam protection.
• All JavaScript can befully disabled.
• Customizable Table of Contents.
• Customizable secure headers.
• Copy button for code blocks.
• Quick navigation buttons.
• Custom copyright notice.
• Custom canonical URLs.
• Custom shortcodes.
• Customizable skins.
• Social media cards.
• Responsive design.
• Projects page.
• Archive page.
• Pinned posts.
• Social links.
• Tags.

To add tabi to you existing Zola site:

0. Initialize a Git repository in your project directory (if you haven't already):

git init

1. Add the theme as a git submodule:

git submodule add https://github.com/welpo/tabi.git themes/tabi

Or clone the theme into your themes directory:

git clone https://github.com/welpo/tabi.git themes/tabi

2. Enable the theme in yourconfig.toml:

theme = "tabi"

3. Set atitle in yourconfig.toml:

title = "Your Site Title"

4. Configure code block highlighting in yourconfig.toml:

[markdown]highlight_code =truehighlight_theme ="css"

5. Create acontent/_index.md file. This file controls how your home page looks and behaves. Choose one of the following options:

   Option A: Serve posts from/:

   +++title = "Home"paginate_by = 5  # Show 5 posts per page.+++

   • This will display posts incontent/ with pagination.

   Option B: Serve posts from a different path (e.g.,blog/):

   +++title = "Home"# Note we're not setting `paginate_by` here.[extra]section_path = "blog/_index.md"  # Where to find your posts.max_posts = 5  # Show 5 posts on the home page.+++

   • This will display the latest 5 posts from theblog/ section.
   • Do not setpaginate_by if you choose this option.
   • Use the full path to the section's_index.md file. Usingsection_path = "blog/" will not work.

6. If you want an introduction section (see screenshot above), add these lines tocontent/_index.md:

[extra]header = {title = "Hello! I'm tabi~", img = "img/main.webp", img_alt = "Your Name" }

The 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…".

7. If you want a multilingual site, you will need to set up each language. Inconfig.toml, set the title and taxonomies for each language, like:

[languages.es]title ="~/tabi"taxonomies = [{name ="tags",feed =true}]

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.

The 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 ofsecurity.md would besecurity.es.md).

This 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.

To learn more about multilingual support, see theFrequently Asked Questions.

If you added the theme as a git submodule, run:

git submodule update --remote themes/tabi

If you cloned it:

cd themes/tabigit pull

Using tabi? Feel free to create a PR and add your site to this list.

This theme was inspired by:

• shadharon — tabi started as a fork ofsyedzayyan's theme
• tailwind-nextjs-starter-blog
• abridge

Something not working? Have an idea? Let us know!

• Questions? →Start a discussion
• Found a bug? →Report it here
• Feature request? →Tell us more!

Please do! We appreciate bug reports, improvements to translations or documentation (however minor), feature requests…

Take a look at theContributing Guidelines to learn more.

The code is available under theMIT license.