https://github.com/welpo/tabi-start
Get your personal site up in a few minutes. Powered by Zola and tabi: https://github.com/welpo/tabi
https://github.com/welpo/tabi-start
blog-theme static-site tabi template template-repository zola
Last synced: 3 months ago
JSON representation
Get your personal site up in a few minutes. Powered by Zola and tabi: https://github.com/welpo/tabi
- Host: GitHub
- URL: https://github.com/welpo/tabi-start
- Owner: welpo
- Created: 2024-11-27T20:20:15.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-14T21:27:52.000Z (3 months ago)
- Last Synced: 2025-07-15T02:16:42.418Z (3 months ago)
- Topics: blog-theme, static-site, tabi, template, template-repository, zola
- Homepage: https://tabi-start.pages.dev/
- Size: 70.3 KB
- Stars: 6
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tabi start
Start blogging in minutes with [Zola](https://www.getzola.org/) and [tabi](https://github.com/welpo/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](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-icons), your [email](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#encoded-email)…). The [Mastering tabi Settings](https://welpo.github.io/tabi/blog/mastering-tabi-settings/) guide has more details.
## File structure
```tree
├── 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](https://www.getzola.org/documentation/getting-started/installation/)
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](https://tabi-start.pages.dev/).
## Deployment
Refer to the [Zola documentation](https://www.getzola.org/documentation/deployment/overview/):
- [AWS S3 Bucket](https://www.getzola.org/documentation/deployment/aws-s3/)
- [Cloudflare Pages](https://www.getzola.org/documentation/deployment/cloudflare-pages/)
- [Codeberg Pages](https://www.getzola.org/documentation/deployment/codeberg-pages/)
- [Docker image](https://www.getzola.org/documentation/deployment/docker-image/)
- [Edgio](https://www.getzola.org/documentation/deployment/edgio/)
- [Fly.io](https://www.getzola.org/documentation/deployment/flyio/)
- [GitHub Pages](https://www.getzola.org/documentation/deployment/github-pages/)
- [GitLab Pages](https://www.getzola.org/documentation/deployment/gitlab-pages/)
- [Netlify](https://www.getzola.org/documentation/deployment/netlify/)
- [Sourcehut Pages](https://www.getzola.org/documentation/deployment/sourcehut/)
- [Vercel](https://www.getzola.org/documentation/deployment/vercel/)
- [Zeabur](https://www.getzola.org/documentation/deployment/zeabur/)
## Updating tabi
### Automated updates
This template includes a [GitHub Action workflow](https://github.com/welpo/tabi-start/blob/main/.github/workflows/update-tabi.yml) 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
```bash
git submodule update --remote themes/tabi
```
## Support
- [tabi documentation](https://welpo.github.io/tabi/)
- [Zola documentation](https://www.getzola.org/documentation/getting-started/overview/)
> [!TIP]
> How was your experience with this template?
>
> Share your thoughts in this [tabi discussion](https://github.com/welpo/tabi/discussions/440) or [report any issues](https://github.com/welpo/tabi/issues/new?&labels=bug&template=2_bug_report.yml) you find! Thank you 🙇🏼♂️