docmd v0.4.11: оптимизация производительности, улучшение вложений и уменьшение размера ядра

#docmd#performance#documentation#javascript

TL;DR: docmd v0.4.11 приносит улучшения в производительности, более надежные вложенные структуры и уменьшенный размер runtime. Это легкий и быстрый движок для документации без необходимости использования тяжелых фреймворков.

Введение

В мире разработки документации скорость и простота имеют ключевое значение. docmd — это zero-config движок для генерации документации, который создает семантический HTML и превращает его в легковесное SPA без необходимости использования тяжелых фреймворков. В релизе v0.4.11 разработчики продолжают курс на минимализм и производительность, внедряя улучшения, которые делают docmd еще более привлекательным выбором для разработчиков.

Основные изменения в v0.4.11

1. Ускорение переходов между страницами

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

// Пример настройки prefetching в docmd
docmd.prefetch({
  strategy: 'intelligent',
  threshold: 0.5
});

2. Улучшение вложенных структур

Вложенные структуры, такие как Cards внутри Tabs внутри Steps, теперь работают более надежно. Это особенно важно для сложной документации, где требуется глубокая вложенность компонентов.

<!-- Пример вложенной структуры в docmd -->
<steps>
  <step title="Step 1">
    <tabs>
      <tab title="Tab 1">
        <card title="Card 1">
          Content of Card 1
        </card>
      </tab>
    </tabs>
  </step>
</steps>

3. Уменьшение размера runtime

Размер runtime был уменьшен до ~15kb, что делает docmd одним из самых легковесных движков для документации. Это достигается за счет отказа от использования тяжелых фреймворков, таких как React или Vue, и использования чистого JavaScript.

# Установка docmd
npm install -g @docmd/core

4. Улучшения в оффлайн поиске

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

// Пример использования оффлайн поиска
docmd.search({
  offline: true,
  index: 'my-docs-index'
});

Практическое применение

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

# Быстрый старт с docmd
docmd init my-docs
cd my-docs
docmd serve

Заключение

docmd v0.4.11 продолжает курс на минимализм и производительность, предлагая разработчикам легковесный и быстрый движок для документации. Улучшения в производительности, надежности вложенных структур и уменьшении размера runtime делают этот релиз еще более привлекательным. Если вы еще не пробовали docmd, сейчас самое время это сделать.

Для получения дополнительной информации посетите официальную документацию и репозиторий на GitHub.

Источник: https://github.com/docmd-io/docmd