Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 5.27 KB

README.md

File metadata and controls

116 lines (87 loc) · 5.27 KB

Built with Zola tabi theme Documentation

tabi start

Start blogging in minutes with Zola and tabi.

Quick start

  1. On the top right of this page, click "Use this template" → "Create a new repository"
  2. Replace placeholders in content/_index.md and in the first four lines of config.toml
  3. Save your profile photo to static/img/profile.webp (or change the path to your image in content/_index.md)
  4. Start writing in content/blog/. See content/blog/hello.md for an example

Note: an error like Tried to build search index for language ko which is not supported, means Zola does not support search for that language. To disable search, set build_search_index = false in config.toml

Tip

Take a look through config.toml to customise further (set up social links, your email…). The Mastering tabi Settings guide has more details.

File structure

├── config.toml              # Site configuration
├── content/
│   ├── _index.md            # Home page
│   ├── archive/             # Archive page
│   │   └── _index.md        # Archive page section
│   ├── blog/                # Blog posts
│   │   ├── hello.md         # Sample post
│   │   └── _index.md        # Blog section configuration
│   └── projects/            # Projects page
│       ├── cool_project.md  # Sample project
│       └── _index.md        # Projects section configuration
│── static/
│   └── img/
│       └── profile.webp     # Profile photo for home page
└── themes/
    └── tabi/                # tabi theme

Local development

  1. Install Zola
  2. Clone your repository
  3. Run git submodule update --init --recursive
  4. Run zola serve
  5. Visit http://127.0.0.1:1111. You should see this.

Deployment

Refer to the Zola documentation:

Updating tabi

Automated updates

This template includes a GitHub Action workflow that checks for tabi theme updates weekly and creates a PR when updates are available.

Setting up permissions

The automated updates require proper GitHub Actions permissions:

  1. Go to your repository's Settings → Actions → General
  2. Scroll down to "Workflow permissions"
  3. Enable "Allow GitHub Actions to create and approve pull requests"
  4. Save changes
How automated updates work (click to read)
  • Every Monday at midnight (UTC), the workflow checks for new tabi versions
  • If an update is found, it creates a PR with:
    • Detailed changelog
    • Links to relevant commits and PRs
    • The exact changes being made
  • It runs the Test build workflow. If the build fails, you'll receive an email notification. Verify the site works locally before merging the PR
  • You can review and merge these updates at your convenience

Manual updates

git submodule update --remote themes/tabi

Support

Tip

How was your experience with this template?

Share your thoughts in this tabi discussion or report any issues you find! Thank you 🙇🏼‍♂️