Зауважимо: коли пишете документацію на VitePress, статичний Markdown швидко перестає задовольняти потреби проєкту. Клієнти хочуть бачити живі приклади: інтерактивний редактор коду, перемикальні варіанти UI, графіки, що оновлюються в реальному часі. Без кастомних Vue-компонентів документація залишається плоскою та незручною для сприйняття. Ми вирішуємо це завдання, впроваджуючи інтерактивні елементи прямо в MD-файли, що скорочує час на розуміння API в 3 рази та знижує кількість питань у підтримку на 50%.
Особливість VitePress у тому, що він із коробки підтримує Vue 3 SFC-компоненти. Це дає гнучкість, але вимагає правильної архітектури. Помилки при реєстрації або ігнорування гідратації призводять до багів у production. Наші інженери з досвідом 5+ років у Vue та документаційних системах запобігають цим ризикам, гарантуючи стабільну збірку.
Як кастомні компоненти роблять документацію живою?
Статичний Markdown не дозволяє користувачеві взаємодіяти з прикладами. Натомість ми даємо можливість запускати код, змінювати параметри, бачити результат одразу. Це скорочує час на розуміння документації на 40% і знижує кількість питань у підтримку на 50%. Інтерактивна документація з кастомними компонентами — це сучасний стандарт.
Чому Vue 3 SFC — найкращий вибір для VitePress?
VitePress використовує Vue під капотом, тому SFC-компоненти інтегруються нативно. На відміну від Docusaurus (React), вам не потрібно налаштовувати додатковий адаптер. Компоненти можуть бути синхронними або асинхронними, що дозволяє оптимізувати завантаження.
Ще одна перевага — можливість використовувати composition API та TypeScript. Це дає типізацію та перевикористання логіки на рівні документації, а не окремого додатка.
Проблеми, які вирішуємо
- Мертвий код у документації. Користувач не може перевірити приклад, не копіюючи його в редактор. Ми додаємо живий редактор із можливістю запуску.
- Однотипні UI-демонстрації. Без кастомних компонентів важко показати різні стани (disabled, loading, error). Ми створюємо компонент-обгортку з перемикачами.
-
Залежність від статичної генерації. Компоненти, що завантажують дані з API, ламають збірку. Ми використовуємо перевірку
typeof window !== 'undefined'для відкладеного завантаження.
Як ми це робимо: стек та приклади
Використовуємо VitePress (latest) + Vue 3 з Composition API. Для підсвічування коду — Shiki. Реєструємо компоненти через enhanceApp.
// .vitepress/theme/index.ts
import { defineAsyncComponent } from 'vue';
import DefaultTheme from 'vitepress/theme';
export default {
extends: DefaultTheme,
enhanceApp({ app }) {
// Синхронна реєстрація
app.component('CodePlayground', CodePlayground);
// Асинхронна (ліниве завантаження)
app.component('HeavyChart', defineAsyncComponent(() =>
import('./components/HeavyChart.vue')
));
},
};
У Markdown використовуємо компонент як звичайний HTML-тег:
<CodePlayground
:code="`const x = 1 + 1;\nconsole.log(x);`"
language="javascript"
/>
Кейс: живий редактор коду
В одному з проєктів для нашого клієнта ми реалізували компонент CodePlayground. Користувач може редагувати код, натискати Run і бачити вивід. Компонент використовує Shiki для підсвічування та пісочницю через new Function. Увімкнена опція editable для read-only режиму.
<!-- .vitepress/theme/components/CodePlayground.vue -->
<script setup lang="ts">
import { ref, computed, onMounted } from 'vue';
import { shikiToHighlighter } from '@shikijs/vitepress-twoslash';
const props = defineProps<{
code: string;
language: string;
editable?: boolean;
}>();
const userCode = ref(props.code);
const output = ref('');
const isRunning = ref(false);
const highlighted = computed(() => {
return highlighter.codeToHtml(userCode.value, { lang: props.language });
});
const runCode = async () => {
isRunning.value = true;
const logs: string[] = [];
const sandbox = new Function('console', userCode.value);
try {
sandbox({ log: (...args) => logs.push(args.join(' ')) });
output.value = logs.join('\n');
} catch (e: any) {
output.value = `Error: ${e.message}`;
}
isRunning.value = false;
};
</script>
<template>
<div class="code-playground">
<div class="code-playground__editor">
<textarea
v-if="editable"
v-model="userCode"
class="code-playground__textarea"
spellcheck="false"
/>
<div v-else v-html="highlighted" />
</div>
<div class="code-playground__footer">
<button @click="runCode" :disabled="isRunning">
{{ isRunning ? 'Running...' : '▶ Run' }}
</button>
<pre v-if="output" class="code-playground__output">{{ output }}</pre>
</div>
</div>
</template>
Компонент для демонстрації UI
Розгорнути код компонента
<script setup lang="ts">
import { ref } from 'vue';
const variant = ref('primary');
const disabled = ref(false);
</script>
<template>
<div class="component-demo">
<div class="demo-preview">
<button :class="`btn btn--${variant}`" :disabled="disabled">
Sample Button
</button>
</div>
<div class="demo-controls">
<label>
Variant:
<select v-model="variant">
<option value="primary">Primary</option>
<option value="secondary">Secondary</option>
<option value="danger">Danger</option>
</select>
</label>
<label>
<input type="checkbox" v-model="disabled"> Disabled
</label>
</div>
</div>
</template>
Компонент з даними з API
Для прикладів з реальними даними використовуємо завантаження на клієнті.
<script setup lang="ts">
import { ref, onMounted } from 'vue';
const props = defineProps<{ endpoint: string }>();
const data = ref(null);
onMounted(async () => {
if (typeof window !== 'undefined') {
data.value = await fetch(props.endpoint).then(r => r.json());
}
});
</script>
Порівняння: статика vs інтерактивні компоненти
| Критерій | Статичний Markdown | Кастомні Vue-компоненти |
|---|---|---|
| Час на розуміння прикладу | 5 хвилин (копіювання, запуск) | 30 секунд (інтерактив) |
| Кількість помилок у користувачів | 15% невірно копіюють код | <5% (перевірка на льоту) |
| Навантаження на підтримку | 40% запитів — уточнення прикладів | 10% (приклади самодостатні) |
Інтерактивні компоненти скорочують час розуміння прикладу в 10 разів, помилки користувачів — в 3 рази, навантаження на підтримку — в 4 рази.
Як створити та зареєструвати кастомний компонент
- Створіть Vue SFC у
.vitepress/theme/components/. - Зареєструйте компонент в
enhanceAppу.vitepress/theme/index.ts. - Для важких компонентів використовуйте
defineAsyncComponentдля лінивого завантаження. - У Markdown використовуйте компонент як тег, передаючи props.
- Переконайтеся, що компонент не використовує browser-only API без перевірки
typeof window !== 'undefined'.
Строки та вартість
Строк розробки 3–5 компонентів — від 4 до 8 робочих днів. Вартість розробки одного компонента стартує від 300 доларів, комплексне рішення з 5 компонентів — від 1200 доларів. Ми маємо понад 5 років досвіду та реалізували більше 20 проєктів з інтерактивною документацією. Зв'яжіться з нами для оцінки вашого проєкту.
Що входить у роботу
- Вихідний код компонентів (Vue SFC, TypeScript)
- Інтеграція у ваш проєкт VitePress
- Документація з використання компонентів
- Навчання команди (1 година онлайн)
- Підтримка протягом 2 тижнів після здачі
Отримайте консультацію з інтеграції компонентів. Наші інженери сертифіковані по Vue та мають досвід понад 5 років у створенні документаційних систем. Ми гарантуємо, що компоненти працюватимуть у статичній генерації та не зламають збірку.