tabi

? таби

Доступная тема Zola с поиском, многоязычной поддержкой, дополнительным JavaScript, отличной оценкой Lighthouse и подробной документацией. Создан для личных сайтов и блогов.

Кончик

Хотите начать вести блог прямо сейчас? Используйте шаблон tabi-start, чтобы создать полноценный сайт за считанные минуты.

Предварительный просмотр (и документацию темы) смотрите здесь.

Изучите раздел «Сайты с использованием таби», чтобы увидеть реальные приложения.

таби (旅, / t ɐ ˈ b i /): Путешествие.

Таби имеет высший балл по результатам аудита Google Lighthouse:

Функции

• Установите любой язык по умолчанию. Установите для базового сайта китайский, испанский, французский, хинди… или любой другой поддерживаемый язык. Интерфейс темы будет переведен соответствующим образом.
• Интеграция с удаленными репозиториями на GitHub, GitLab, Gitea и Codeberg для истории коммитов и отображения исходного кода сайта.
• Поддержка серий для создания последовательного контента, такого как учебные пособия, курсы и истории, состоящие из нескольких частей.
• Темные и светлые темы. По умолчанию используются настройки ОС, с переключателем на панели навигации.
• Тщательная документация. См. «Освоение настроек таби: подробное руководство».
• Идеальная оценка Lighthouse (производительность, доступность, лучшие практики и SEO).
• Комплексная многоязычная поддержка. Добавьте столько языков, сколько пожелаете.
• Поддержка комментариев с использованием giscus, высказываний, Hyvor Talk или Isso.
• Подсветка синтаксиса кода цветами на основе Catppuccin Frappé.
• Поддержка Mermaid для создания диаграмм и диаграмм с текстом.
• Локальный поиск с доступным многоязычным интерфейсом.
• Пользовательская карточка Twitter и автоматические теги Open Graph.
• Поддержка KaTeX для математической записи.
• Стилизованный и удобочитаемый канал Atom.
• Стилизованная и удобочитаемая карта сайта.
• Кодировка почты для защиты от спама.
• Весь JavaScript можно полностью отключить.
• Настраиваемое оглавление.
• Настраиваемые безопасные заголовки.
• Кнопка копирования для блоков кода.
• Кнопки быстрой навигации.
• Специальное уведомление об авторских правах.
• Пользовательские канонические URL-адреса.
• Пользовательские короткие коды.
• Настраиваемые скины.
• Карты социальных сетей.
• Адаптивный дизайн.
• Страница проектов.
• Страница архива.
• Закрепленные сообщения.
• Социальные ссылки.
• Теги.

Установка

Примечание

Самый быстрый способ создать новый сайт — использовать шаблон tabi-start. Это дает вам полную настройку блога со всеми необходимыми настройками, готовыми к работе.

Ручная установка

Чтобы добавить таби на существующий сайт Zola:

0. Инициализируйте репозиторий Git в каталоге вашего проекта (если вы еще этого не сделали):

 git init

1. Добавьте тему как подмодуль git:

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

Или клонируйте тему в каталог тем:

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

Требуемая конфигурация

2. Включите тему в вашем config.toml :

 theme = "tabi"

3. Установите title в вашем config.toml :

 title = "Your Site Title"

4. Настройте подсветку блоков кода в вашем config.toml :

[ markdown ]
highlight_code = true
highlight_theme = " css "

5. Создайте файл content/_index.md . Этот файл управляет тем, как выглядит и ведет себя ваша домашняя страница. Выберите один из следующих вариантов:

   Вариант А: Публикуйте сообщения из / :

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

   • При этом сообщения будут отображаться в content/ с нумерацией страниц.

   Вариант Б. Размещайте сообщения по другому пути (например, 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.
   +++
   

   • Будут отображены последние 5 сообщений из blog/ раздела.
   • Не устанавливайте paginate_by , если вы выберете эту опцию.
   • Используйте полный путь к файлу _index.md раздела. Использование section_path = "blog/" не будет работать.

Предупреждение

Не устанавливайте одновременно paginate_by section_path в content/_index.md .

Эти настройки являются взаимоисключающими, и использование обоих может привести к тому, что сообщения не будут отображаться.

6. Если вам нужен вводный раздел (см. снимок экрана выше), добавьте эти строки в content/_index.md :

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

Содержимое за пределами вступительной части будет отображаться между заголовком заголовка и списком сообщений. На скриншоте выше текст гласит: «tabi — это быстрая, легкая и современная тема Zola…».

7. Если вам нужен многоязычный сайт, вам нужно будет настроить каждый язык. В config.toml установите заголовок и таксономию для каждого языка, например:

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

Вам понадобится _index.{language_code}.md для каждого языка для каждого раздела (например, /blog или /projects), который вы хотите включить на этом языке.

То же самое относится и к отдельным сообщениям, которые должны иметь то же имя, что и язык по умолчанию, с дополнительным .{code} перед расширением (например, испанская версия security.md будет называться security.es.md ).

Эта конфигурация позволяет переключателю языка перевести пользователя на перевод текущего URL-адреса. Если перевода не существует, отобразится страница 404 с объяснением на каждом языке, установленном в конфигурации.

Дополнительную информацию о многоязычной поддержке см. в разделе «Часто задаваемые вопросы».

Обновление таби

Если вы добавили тему как подмодуль git, запустите:

git submodule update --remote themes/tabi

Если вы клонировали его:

 cd themes/tabi
git pull

Сайты, использующие таби

Веб-сайт	Создатель	Описание	Источник сайта
оск.сад	Оскар Фернандес (welpo)	Наука о данных, психология и Золя	Источник
Sandip.live	Сандип Джи (песчаный человек)	Стартапы, технологии и хорошая жизнь	Источник
seadve.github.io	Дэйв Патрик Каберто (SeaDve)	Личный блог и портфолио с пользовательским CSS	Источник
mikufan.page	Надя	Личный блог	Источник
Тим-Boettcher.online	Тим Бетчер	Идеи и бред слепоглухого программиста	Источник
www.richtman.au	Ариэль Рихтман	Личный технический блог	Источник
Пондероза Игры	Джон Бурак (ДжейВаймс)	Дружелюбная компания, занимающаяся инди-играми.	—
jmbhughes.com	Маркус Хьюз (jmbhughes)	Личный блог	Источник
szabolcs.me	Сабольч Фазекас (szabolcsf)	Личный блог	Источник

Используете таби? Не стесняйтесь создавать PR и добавлять свой сайт в этот список.

Вдохновение

Эта тема была вдохновлена:

• шадхарон — таби началось как ответвление темы седзайяна
• попутный ветер-nextjs-starter-блог
• сокращать

Поддерживать

Что-то не работает? Есть идея? Дайте нам знать!

• Вопросы? → Начать обсуждение
• Нашли ошибку? → Сообщите об этом здесь
• Запрос на функцию? → Расскажите нам больше!

Содействие

Пожалуйста, сделайте! Мы признательны за сообщения об ошибках, улучшения переводов или документации (пусть даже незначительные), запросы новых функций…

Чтобы узнать больше, ознакомьтесь с Руководством по участию.

Лицензия

Код доступен по лицензии MIT.