Teedoc

中文 | English

Official site: teedoc.neucrack.com or teedoc.github.io

More demo: see here или here.

Инструмент для создания документации из Markdown и Jupyter Notebook в HTML.

Применение:

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

Особенности:

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

Начало работы: Посетите официальный сайт: teedoc.github.io.

Создайте свой веб-сайт на страницах GitHub за считанные минуты.

См. шаблон репозитория 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

Выберите минимальный шаблон в promot.

• Установите плагины: Эта команда установит плагины, используемые doc (установленные в site_config.json):

cd my_site
teedoc install

• Постройте или обслуживайте:

teedoc serve

затем посетите http://127.0.0.1:2333 в браузере. Если вы хотите только создать HTML:

teedoc build