diff --git a/README.md b/README.md index a0de116..c804737 100644 --- a/README.md +++ b/README.md @@ -1,243 +1,6 @@

- PRs welcome - - Contributors - - Forks - - Last commit -
- - Latest release - - Documentation - - License - - Clean commits - - Average time to resolve an issue - - Percentage of issues still open + Build status

-# 🌱 tabi - -An 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. - -> [!TIP] -> 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. - -See a live preview (and the theme's documentation) [here](https://welpo.github.io/tabi). - -Explore the [Sites Using tabi section](#sites-using-tabi) to see real-world applications. - -> tabi (旅, /tɐˈbi/): Journey. - -![tabi](https://github.com/welpo/tabi/raw/main/light_dark_screenshot.png) - -tabi has a perfect score on Google's Lighthouse audit: - -![lighthouse](https://raw.githubusercontent.com/welpo/tabi/main/lighthouse_score.png) - -## Features - -- [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. -- [X] [Integration with remote repositories](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#git-repository-integration) on GitHub, GitLab, Gitea & Codeberg for commit history and showing the site source. -- [X] [Series support](https://welpo.github.io/tabi/blog/series/) for creating sequential content like tutorials, courses, and multi-part stories. -- [X] Dark and light themes. Defaults to the OS setting, with a switcher in the navigation bar. -- [X] Thorough documentation. See [Mastering tabi Settings: A Comprehensive Guide](https://welpo.github.io/tabi/blog/mastering-tabi-settings/). -- [X] Perfect Lighthouse score (Performance, Accessibility, Best Practices and SEO). -- [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. -- [X] Support for [comments using giscus, utterances, Hyvor Talk, or Isso](https://welpo.github.io/tabi/blog/comments/). -- [X] Code syntax highlighting with colours based on [Catppuccin](https://github.com/catppuccin/catppuccin) Frappé. -- [X] [Mermaid support](https://welpo.github.io/tabi/blog/shortcodes/#mermaid-diagrams) to create diagrams and charts with text. -- [X] [Local search](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#search) with an accessible, multi-lingual interface. -- [X] [Custom Twitter card](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-cards) and automatic Open Graph tags. -- [X] [KaTeX](https://katex.org/) support for mathematical notation. -- [X] [Stylized and human readable Atom feed](https://welpo.github.io/tabi/atom.xml). -- [X] [Stylized and human readable sitemap](https://welpo.github.io/tabi/sitemap.xml). -- [X] [Mail encoding](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#encoded-email) for spam protection. -- [X] All JavaScript can be [fully disabled](https://welpo.github.io/tabi/blog/javascript/). -- [X] [Customizable Table of Contents](https://welpo.github.io/tabi/blog/toc/). -- [X] [Customizable secure headers](https://welpo.github.io/tabi/blog/security/). -- [X] [Copy button for code blocks](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#copy-button-on-code-blocks). -- [X] [Quick navigation buttons](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#quick-navigation-buttons). -- [X] [Custom copyright notice](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#copyright). -- [X] [Custom canonical URLs](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#canonical-url). -- [X] [Custom shortcodes](https://welpo.github.io/tabi/blog/shortcodes/). -- [X] [Customizable skins](https://welpo.github.io/tabi/blog/customise-tabi/). -- [X] [Social media cards](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-cards). -- [X] Responsive design. -- [X] [Projects page](https://welpo.github.io/tabi/projects/). -- [X] [Archive page](https://welpo.github.io/tabi/archive/). -- [X] [Pinned posts](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#pinning-posts). -- [X] [Social links](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#social-media-icons). -- [X] [Tags](https://welpo.github.io/tabi/blog/mastering-tabi-settings/#tags). - -## Installation - -> [!NOTE] -> 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. - -### Manual installation - -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 -``` - -### Required configuration - -2. Enable the theme in your `config.toml`: - -``` -theme = "tabi" -``` - -3. Set a `title` in your `config.toml`: - -``` -title = "Your Site Title" -``` - -4. Configure code block highlighting in your `config.toml`: - -```toml -[markdown] -highlight_code = true -highlight_theme = "css" -``` - -5. Create a `content/_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 in `content/` 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 the `blog/` section. - - Do not set `paginate_by` if you choose this option. - - Use the full path to the section's `_index.md` file. Using `section_path = "blog/"` will not work. - -> [!WARNING] -> Do not set both `paginate_by` and `section_path` in `content/_index.md`. -> -> These settings are mutually exclusive and using both may result in no posts being displayed. - -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 = "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. In `config.toml`, set the title and taxonomies for each language, like: - -```toml -[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 of `security.md` would be `security.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 the [Frequently Asked Questions](https://welpo.github.io/tabi/blog/faq-languages/). - -### Updating tabi - -If you added the theme as a git submodule, run: - -```bash -git submodule update --remote themes/tabi -``` - -If you cloned it: - -```bash -cd themes/tabi -git pull -``` - -## Sites using tabi - -| Website | Creator | Description | Site Source | -| - | - | - | - | -| [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) | -| [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) | -| [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) | -| [mikufan.page](https://mikufan.page) | [Nadia](https://github.com/nyadiia) | Personal blog | [Source](https://github.com/nyadiia/mikufan.page) | -| [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/) | -| [www.richtman.au](https://www.richtman.au) | [Ariel Richtman](https://github.com/arichtman) | Personal tech blog | [Source](https://github.com/arichtman/www.richtman.au) | -| [Ponderosa Games](https://ponderosagames.com/) | John Burak ([JVimes](https://github.com/jvimes)) | A friendly indie game company | — | -| [jmbhughes.com](https://jmbhughes.com/) | Marcus Hughes ([jmbhughes](https://github.com/jmbhughes)) | Personal blog | [Source](https://github.com/jmbhughes/jmbhughes.github.io) | -| [szabolcs.me](https://szabolcs.me) | Szabolcs Fazekas ([szabolcsf](https://github.com/szabolcsf)) | Personal blog | [Source](https://github.com/szabolcsf/szabolcs.me) | - - -Using tabi? Feel free to create a PR and add your site to this list. - -## Inspiration - -This theme was inspired by: -- [shadharon](https://github.com/syedzayyan/shadharon) — tabi started as a fork of [syedzayyan](https://github.com/syedzayyan)'s theme -- [tailwind-nextjs-starter-blog](https://github.com/timlrx/tailwind-nextjs-starter-blog) -- [abridge](https://github.com/Jieiku/abridge) - -## Support - -Something not working? Have an idea? Let us know! - -- Questions? → [Start a discussion](https://github.com/welpo/tabi/discussions) -- Found a bug? → [Report it here](https://github.com/welpo/tabi/issues/new?&labels=bug&template=2_bug_report.yml) -- Feature request? → [Tell us more!](https://github.com/welpo/tabi/issues/new?&labels=feature&template=3_feature_request.yml) - -## Contributing - -Please do! We appreciate bug reports, improvements to translations or documentation (however minor), feature requests… - -Take a look at the [Contributing Guidelines](/CONTRIBUTING.md) to learn more. - -## License - -The code is available under the [MIT license](./LICENSE). +# 🌱 alexohneander