Рубрики
Без рубрики

Kb4it.

Статический генератор веб-сайта на основе источников Asciidoctor в основном для целей технической документации. Теги с Asciidoctor, пишет, Python, Uikit.

Введение

KB4IT – это статический генератор веб-сайта, основанный на источниках Asciidoctor в основном для целей технической документации.

KB4IT обозначает базу знаний для нее.

Воспользоваться Определенные пользователем атрибуты Особенность в Asciidoctor, KB4IT может анализировать источники Asciidoctor, извлечь все метаданные доступными и создать нечто похожее на вики. Таким образом, вся информация, предоставленная пользователем, может быть легко связана.

Пожалуйста, обратите внимание, что приложение является все еще под разработкой . Тем не менее, я использую его в моем дне в день для собственного хранилища документации.

Я был бы очень признателен, если бы вы могли проверить это и сказать мне свое мнение.

Демонстрация

Перед продолжением читать детали, вы можете взглянуть на Демо иметь представление о том, что все это проект.

Мотивации

The main aim is to provide an easy way to write technical documentation.
  • Не заботитесь о форматировании и сосредоточении на содержании.
  • Разрешить команды легко управлять базой данных их знаний.
  • Не зависят от третьего программных продуктов, таких как процессоры Word или сложные веб-приложения.

Функции

Плюс

  • Легко написать техническую документацию

Документы должны быть в формате Asciidoctor, который легко учиться.

Для каждого опубликованного документа есть его соответствующий источник Acciidoctor. Таким образом, вы можете использовать его как шаблон для написания другого документа, не тратя слишком много времени.

  • Легко найти документацию

Каждый документ имеет свойства, которые можно просматривать. Эти Страницы недвижимости Используйте фильтры.

Более того, есть поиск ввода для фильтрации результатов, написав некоторые буквы названия.

  • Легко публиковать документацию

Все документы, которые вы пишете, скомпилированы/преобразованы в HTML-файлы.

Просто поместите их в любую папку и укажите браузер:

/target/path/index.html c: \ target \ path \ index.html

Однако вы можете загружать/скопировать их на свой веб-сервер.

  • Легко резервное копирование/восстановление документации

Просто резервное копирование ваших источников и восстановить их на другом ПК или сервере. Используйте приложение KB4IT, чтобы скомпилировать их снова.

Конечно, вы можете сделать резервную копию целевого каталога со всеми HTML-файлами и ресурсами, и он будет работать где угодно.

  • Serverless

Нет необходимости в веб-сервере. Конечно, вы можете использовать один, если хотите.

KB4IT был разработан для работы в смешанных средах, где люди используют общие папки (например,: Акции Windows или каталоги, установленные NFS).

  • Умный компиляция

Составлены только те документы, добавленные или модифицированные. Это резко уменьшается количество времени и процессор, необходимое для создания веб-сайта.

Для достижения этого KB4IT использует кэш. Если кеш удален или отсутствует, весь репозиторий снова скомпилирован.

Чтобы ускорить компиляцию, KB4IT использует резьбу. По умолчанию он запускает 30 потоков параллельно. Итак, пожалуйста, будьте в курсе этой функции, поскольку она будет съесть весь процессор доступен до завершения компиляции.

Господин

  • Нет онлайн-редактора.
  • Там нет динамического поиска (поиск основан на статических фильтрах, сгенерированных каждый раз, когда страница скомпилирована).
  • KB4IT не работает в Windows.

Зависимости

Лицензия

Код лицензирован в соответствии с условиями GPL V3 Таким образом, вы можете воспользоваться, продлеваться, улучшать и вилить код, как вы хотите.

Скачать

Вы можете скачать исходный код в GitHub:

T00M/KB4IT.

KB4IT – это статический генератор веб-сайта, основанный на источниках Asciidoctor в основном для целей технической документации.

О компании KB4IT.

Введение

KB4IT является статическим генератором веб-сайта на основе источников Asciidoctor в основном для целей технической документации.

Вы можете увидеть некоторые демонстрации здесь: https://github.com/t00m/kb4it-adocs.

Мотивации

  • Главная цель состоит в том, чтобы предоставить простой способ написать мою техническую документацию.

  • Не заботитесь о форматировании и сосредоточении на содержании.

  • Разрешить команды легко управлять базой данных их знаний.

  • Не зависят от третьего программных продуктов, таких как процессоры Word или сложные веб-приложения.

Функции

Плюс

  • Написание документации: документы должны быть в формате Asciidoctor, который легко учиться.

  • Поиск документов: После того, как документ преобразуется в HTML, свойства могут просматриваться. Кроме того, страницы свойств имеют фильтры и поиск ввод для фильтрации по названию.

  • Публикация вашего репозитория: все необходимые файлы находятся внутри каталога. Просмотрите его или скопируйте его на ваш веб-сервер.

  • Смертный: нет необходимости в веб-сервере. Конечно, вы можете использовать один, если вы …

Оригинал: “https://dev.to/t00m/kb4it-435m”