Быстрый старт
Пошаговое руководство по началу работы с Викикодом.
Требования
| Что | Версия | Для чего |
|---|---|---|
| VS Code, Cursor или VSCodium | VS Code 1.85+ | Обязательно |
| Интернет | — | Для генерации документации |
| Git | Любая | Для Git Hook (автообновление после коммитов) |
| Python 3 | 3.x | Для Git Hook |
Расширение работает в любом редакторе, совместимом с VS Code: VS Code, Cursor, VSCodium, Windsurf и других.
Git и Python нужны только если хотите использовать Git Hook. Для базовой работы с документацией они не обязательны.
Шаг 1. Установите расширение
Скачайте файл .vsix с сайта wikicode.ru и установите:
- Откройте VS Code
Ctrl+Shift+P→ Extensions: Install from VSIX...- Выберите скачанный файл
- Перезагрузите редактор
После установки в боковой панели появится иконка Викикод.
Шаг 2. Откройте проект
Откройте папку с вашим проектом в VS Code (Ctrl+K Ctrl+O).
Шаг 3. Войдите в аккаунт
Нажмите на иконку Викикод в боковой панели. Выберите способ входа:
- GitHub
- Яндекс
Откроется браузер — подтвердите авторизацию. VS Code автоматически вернётся к работе.
Шаг 4. Пройдите онбординг
После входа откроется пошаговый визард из трёх шагов:
Git Hook — рекомендуем нажать «Установить Git Hook». После этого документация будет обновляться автоматически после каждого коммита. Можно пропустить и настроить позже.
MCP-сервер — если используете Claude, Cursor или Copilot, нажмите «Настроить MCP», чтобы AI-ассистенты могли читать документацию вашего проекта. Можно пропустить.
База знаний — нажмите «Создать базу знаний». Викикод начнёт анализировать проект и создавать документацию. Этот шаг нельзя пропустить — это главная функция расширения.
Шаг 5. Дождитесь завершения
Сканирование и генерация базы знаний занимают 2–10 минут в зависимости от размера проекта. Прогресс отображается в уведомлении.
По завершении в боковой панели появится дерево документации.
Шаг 6. Просматривайте документацию
В дереве будут доступны:
- База знаний — 20 тематических страниц: архитектура, API, модули, база данных и другие
- Модули — документация по каталогам проекта
- Файлы — документация каждого исходного файла
Нажмите на любой элемент — документация откроется с рендерингом Markdown, оглавлением и диаграммами.
Что дальше?
- Задайте вопрос по коду — AI ответит на основе документации
- Настройте MCP — подключите Claude, Cursor или Copilot к документации
- Изучите все команды — экспорт, обновление, навигация