История обновлений teedoc

2023-02-21 v1.33.1

• Уменьшение размера файлов поискового индекса.
• Поддержка добавления перевода документации в каталог doc, например, мы используем i18n URL типа /doc1/zh/index.html и /doc1/en/index.html, теперь вы также можете использовать основной документ как /doc1/index.html и переводить документ на /doc1/en/index.html.

Структура каталога:

.
└── docs
  └── doc1
    └── en

site_config.json:

{
    "route": {
        "docs": {
            "/doc1/": "docs/doc1"
        },
    },
    "translate": {
        "docs":{
            "/doc1/": [ {
                "url": "/doc1/en/",
                "src": "docs/doc1/en"
            }
            ]
        }
    }
}

2022-09-19

• Добавление плагина thumbs-up.

2022-09-16 v1.31.0

• Поддержка непосредственного использования шаблона Jinja2 в HTML-файле без использования макета в MD-файле, дополнительную информацию см. в разделе синтаксиса HTML документации.

2022-09-16 v1.30.1

• Оптимизация боковой панели.
• Добавление поддержки mermaid для Markdown.
• Игнорирование обнаружения всех временных файлов.
• Обновление парсера Markdown mistune до версии 2.
• Добавление инструмента teedoc-list-files для вывода списка файлов по размеру.
• Добавление инструмента teedoc-compare для сравнения различий между двумя каталогами файлов.
• Добавление инструмента teedoc-upload для загрузки файлов на удалённый сервер, поддержка Tencent Cloud и Qiniu Cloud.
• Оптимизация журнала сборки.
• Новый синтаксис Markdown:
  • tabset (Jupyter пока не поддерживает).
  • details (Jupyter пока не поддерживает).
  • Поддержка настройки идентификатора заголовка с помощью синтаксиса {#id}.
• Полная поддержка метаданных в формате yaml, а также поддержка ключа update для создания истории обновлений.
• Новый логотип teedoc.
• Исправление ошибки, когда длинный TOC не мог отображаться полностью.
• Удаление установки локальных плагинов в команде teedoc install.
• Оптимизация отображения даты последнего изменения.

2022-05-08

• Обновление поддержки тем плагином TOC для мобильных устройств.
• Обновление поддержки блога плагином изображения в кратком обзоре и поддержка ключевого слова cover.

2022-01-06 v1.26.0

• Добавление быстрого режима для команды serve, если используется teedoc serve --fast, то будет только копирование ресурсов, без сборки страниц, затем можно посетить страницу, страница будет собрана при посещении этой страницы. Задача сборки всех страниц также будет работать в фоновом режиме.

2022-01-06 v1.25.0

• Плагин teedoc-plugin-theme-default поддерживает шаблон макета redirect.html, например, если мы хотим, чтобы /maixpy и /maixpy.html перенаправлялись на /soft/maixpy.html, просто создайте файл maixpy.md и добавьте:

---
layout: redirect
redirect_url: /soft/maixpy/zh/
---

• Изменение HTTP-сервера с http.server на flask для большей совместимости с большим количеством устройств.

2021-09-18 v1.24.0

• Плагин teedoc-plugin-ad-hint поддерживает конфигурацию в конфигурации документа, а не только в site_config.
• (для разработчиков) поддержка добавления переменной js_vars в плагин.

2021-09-18 v1.23.1

• Добавление шаблона 404.html, поддержка i18n.

2021-09-08 v1.19.0

• Добавление поддержки i18n для плагинов и шаблонов.
• Добавление комментария плагина teedoc-plugin-comments-gitalk.
• Добавление печати страницы.
• Добавление привязки к заголовкам.
• Добавление предупреждения журнала для неправильного элемента боковой панели.
• Исправлена ошибка: автоматическое обновление страницы при изменении содержимого в режиме предварительного просмотра.
• Исправлен поиск слишком большого файла индекса.
• Исправлены ошибки z-index навигационной панели.
• Исправлена ошибка плавной прокрутки TOC при экранировании символов в идентификаторе.

2021-08-07 v1.17.1

• Добавлена поддержка настройки шаблона макета (Jinja2).

2021-08-03 v1.16.1

• Замена парсера markdown с markdown2 на mistune, теперь сборка происходит быстрее минимум в 2 раза.
• Игнорировать папку .git в файловом наблюдателе.

2021-07-22 v1.15.8

• Оптимизирован файловый наблюдатель, исправлена ошибка переименования в браузере файлов, которая не могла вызвать событие.
• Исправлена ошибка при копировании ошибки (ошибка не найдена).
• В плагин theme_default добавлен просмотрщик изображений для элемента img.

2021-05-21 v1.15.0

• Добавлены команды summary2json и summary2yaml для файла боковой панели gitbook.
• Добавлен разделитель боковой панели, можно установить ширину боковой панели sidebar_width (ширина боковой панели по умолчанию) в конфигурации плагина teedoc-plugin-theme-default, например:

"teedoc-plugin-theme-default": {
    "from": "../../plugins/teedoc-plugin-theme-default",
    "config": {
        "env": {
            "sidebar_width": "300px"
        }
    }
}

2021-05-21 v1.14.0

• Ускорение сборки за счёт перехода от многопоточной сборки к многопроцессорной сборке.

2021-05-21 v1.13.0

• Добавлена опция collapsed: false для боковой панели.