Тидо́к

中文 | English

Веб-сайт: teedoc.neucrack.com или teedoc.github.io

Дополнительные примеры: см. здесь или здесь.

Преобразует документы в формате Markdown или Jupyter Notebook в HTML-страницы.

Teedoc можно использовать в следующих случаях:

• Создание веб-сайта с документацией, который поддерживает несколько документов и настраиваемые страницы.
• Объединение множества документов, разбросанных по разным доменам, на одном домене.
• Создание вики-сайтов.
• Создание личных или корпоративных баз знаний.
• Создание личного или корпоративного веб-сайта.

Функции

• Простота использования, кроссплатформенность, зависимость только от Python3.
• Простая установка, сгенерированный веб-сайт представляет собой полностью статическую страницу, которую можно скопировать на сервер или загрузить в стороннюю организацию для установки.
• Простой процесс написания с использованием синтаксиса Markdown.
• Поддержка Jupyter notebook.
• Поддержка нескольких документов.
• Плагин-поддержка.
• Многотемная поддержка (реализуется через плагины).
• Точное управление стилем страниц с помощью CSS (через пользовательские идентификаторы и классы для каждой страницы).
• Поддержка многоуровневых каталогов.
• Мультиязычная поддержка (ручная локализация) (i18n).
• Мультиязыковая поддержка (плагины для перевода).
• Поисковая поддержка.
• SEO-дружественность.
• Предварительный просмотр изменений в реальном времени.
• Параллельное построение для более быстрой скорости построения.
• Блог-поддержка.
• Поддержка шаблонов HTML с Jinja2.

Начало работы

Веб-сайты: teedoc.github.io, [teedoc.neucrack.com].

Создание собственного веб-сайта за несколько минут на сервисе GitHub Pages

Смотрите репозиторий template.

Быстрый старт

• Установите Python3:
  • Windows или macOS: загрузите установочный пакет с сайта python.org.
  • Linux, например Ubuntu:

sudo apt install python3 python3-pip

* Установите teedoc:
  Эта команда установит основную программу teedoc.

pip3 install -U teedoc

* Инициализируйте документацию:

mkdir my_site cd my_site teedoc init

  Или:

teedoc -d my_site init

> Выберите шаблон minimal согласно подсказкам.

* Установите плагины:
  Эта команда устанавливает необходимые плагины для документации (настраивается в site_config.json):

cd my_site teedoc install

* Постройте (build) или просмотрите (serve):

teedoc serve

Затем перейдите в браузере по адресу [http://127.0.0.1:2333](http://127.0.0.1:2333).
Если вам нужно только построить веб-страницу, выполните:

teedoc build