Документация остаётся обычным Markdown
jekyll-theme-modootoday превращает стандартный GitHub Flavored Markdown в аккуратный сайт документации. Один и тот же файл хорошо читается на github.com, в GitHub Pages и как Markdown-версия для ИИ-агентов.
Почему тема modoo.today
- Только стандартный Markdown Уведомления, таблицы, списки и блоки кода. Никакого HTML, Liquid или расширений kramdown на страницах.
- Работает в GitHub Pages Тема только на Liquid для классической сборки
github-pages, а для остального — Jekyll 4. - Понятно ИИ-агентам У каждой страницы есть побайтно совпадающая Markdown-версия, а также
llms.txtиllms-full.txt.
Быстрый старт
remote_theme
remote_theme: modootoday/jekyll-theme-modootoday@v1.4.1
plugins: [jekyll-remote-theme]
Gemfile
gem "jekyll-theme-modootoday", "~> 1.4"
_config.yml
theme: jekyll-theme-modootoday
permalink: pretty
Как читать документацию
- Установите тему в GitHub Pages или Jekyll 4.
- Напишите первую страницу на обычном Markdown.
- Выберите нужное среди компонентов и на странице со всеми компонентами.
- Настройте сайт в конфигурации и измените оформление с помощью токенов и
_sass. - Сделайте сайт понятным ИИ-агентам с Markdown-версиями и
llms.txt.
Примечание
Эта страница переведена с английского оригинала; при расхождениях действует английская версия. Руководства по ссылкам доступны на английском.