teedoc

Teedoc

中文 | Английский

Официальный сайт: teedoc.neucrack.com или tiedoc.github.io

Больше демонстрации: см. Здесь или здесь

Документация Создайте инструмент от ноутбука Markdown и Jupyter в HTML

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

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

Функции

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

Начните

Посетите официальный сайт: teedoc.github.io или teedoc.neucrack.com

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

Смотрите шаблон репо

Quik Start

• Установите 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

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

• Установите плагины

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

 cd my_site
teedoc install

• строить или подавать

 teedoc serve

Затем посетите http://127.0.0.1:2333 в браузере

Если вы хотите только генерировать HTML:

 teedoc build