nick
/
tabi-test
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
320 Commits
1 Branch
0 Tags
32 MiB
JavaScript 62.5%
HTML 21.1%
SCSS 10%
Shell 4%
XSLT 1.2%
Other 1.2%
 
 
 
 
 
 
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9512bbb194'
${ noResults }
Go to file
welpo 9512bbb194
♻️ refactor: use `const` in theme initialization 
Refactor the theme initialization script to use 'const' instead of 'let'
for the 'currentTheme' variable, as the value is not expected to change
after initialization.

This makes the code more clear and prevents accidental
re-assignment.
 		2 years ago
.github/workflows 🐛 fix: use personal access token 2 years ago
content 🐛 fix: remove flash when navigating in dark-mode 2 years ago
sass 🐛 fix: remove flash when navigating in dark-mode 2 years ago
static ♻️ refactor: use `const` in theme initialization 2 years ago
templates 🐛 fix: remove flash when navigating in dark-mode 2 years ago
.gitignore 🙈 chore: add gitignore 2 years ago
CODE_OF_CONDUCT.md 📝 docs: add code of conduct 2 years ago
CONTRIBUTING.md 📝 docs: improve punctuation 2 years ago
LICENSE 📄 docs: add license 2 years ago
README.md 📝 docs: acknowledge abridge's inspiration 2 years ago
config.toml 🐛 fix: remove flash when navigating in dark-mode 2 years ago
light_dark_screenshot.png 📝 docs: update screenshots 2 years ago
lighthouse_score.png 📝 docs: mention perfect Lighthouse score 2 years ago
screenshot.png 📝 docs: update screenshots 2 years ago
theme.toml 📝 docs: update theme's description 2 years ago

README.md

tabi

A fast, lightweight, and modern Zola theme. It aims to be a personal page and home to blog posts.

See a live preview here.

tabi (旅): Journey.

tabi

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

lighthouse

Features

  • Dark and light themes. Defaults to the OS setting, with a switcher in the navigation bar.
  • Perfect Lighthouse score (Performance, Accessibility, Best Practices and SEO).
  • KaTeX support.
  • All JavaScript (theme switcher and KaTeX) can be fully disabled.
  • Responsive design.
  • Projects page.
  • Archive page.
  • Tags.
  • Social links.
  • Code syntax highlighting.
  • Custom shortcodes.
  • Customizable secure headers.

See the project's roadmap here.

Quick start

git clone https://github.com/welpo/tabi.git
cd tabi
zola serve

Open http://127.0.0.1:1111/ in the browser.

Installation

To add tabi to you existing Zola site:

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

Required configuration

  1. Enable the theme in your config.toml:
theme = "tabi"
  1. Set a title in your config.toml:
title = "Your Site Title"
  1. Create a content/_index.md file with the following content:
+++
title = "Home"
paginate_by = 5 # Set the number of posts per page
template = "index.html"
+++

If you want to serve your blog posts from a different path, such as blog/, add a section_path in the [extra] section of content/_index.md (this file will need pagination):

[extra]
section_path = "blog/_index.md"
  1. If you want an introduction section (see screenshot above), add these lines to content/_index.md:
[extra]
header = {title = "Hello! I'm tabi~", img = "$BASE_URL/img/main.webp" }

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

Inspiration

This theme was inspired by:

Contributing

Please do! Take a look at the Contributing Guidelines to learn more.

License

The code is available under the MIT license.