Lite Invest
Начало работы

Как редактировать базу знаний

Инструкция для редакторов по работе с Nuxt Studio и публикацией материалов.

Как открыть Studio

Редакторская часть доступна по адресу /_studio на домене документации.

Доступ ограниченВойти смогут только Google-аккаунты, добавленные в whitelist переменной STUDIO_GOOGLE_MODERATORS.

Основной процесс

  1. Откройте https://docs.lite-invest.com/_studio.
  2. Войдите через Google OAuth.
  3. Создайте или откройте Markdown-файл в нужном разделе content: например content/getting-started/new-page.md или content/payments/new-page.md.
  4. Проверьте URL: публичный адрес формируется из пути файла, например content/payments/top-up-basics.md открывается как /payments/top-up-basics.
  5. Заполните frontmatter: title, description, tags, updatedAt, cover, featured, priority, navigation и seo.
  6. Если нужно изменить порядок разделов или статей, обновите соответствующий .navigation.yml.
  7. При необходимости загрузите изображения или документы в /public.
  8. Используйте Markdown/MDC компоненты для заметок, шагов, изображений и видео. Небольшие изображения Studio оставит в исходном размере; крупные автоматически уместятся в колонку статьи.
  9. Опубликуйте изменения. Studio создаст commit в GitHub branch main.
Нейтральный пример изображения для проверки медиа в статье.
Демо-видеоПример встроенного видео. В production статье ссылку нужно заменить на актуальный материал.
Готово к публикацииПосле сохранения проверьте preview страницы, SEO-описание и отсутствие служебных данных в тексте.
ЧерновикиНе создавайте черновики внутри content/: всё, что лежит в этом каталоге, считается публичной базой знаний. Материалы, которые не должны попадать в навигацию, поиск и sitemap, храните вне content/, например в drafts/.

Компоненты в статьях

Для заметок используйте note, warning и tip, для инструкций steps, для изображений image-figure, для видео video-embed.

Размер изображений

Обычная картинка, добавленная через Studio, по умолчанию не увеличивается больше своего исходного размера — так небольшие скриншоты остаются чёткими. Большая картинка при этом не выйдет за пределы колонки статьи. При нажатии изображение увеличивается в два раза, но не больше 95% ширины или высоты окна.

Если скриншот нужно намеренно растянуть на всю ширину колонки, в Markdown добавьте к нему класс full-width:

![Описание скриншота](/media/screenshot.png){.full-width}

Для компонента image-figure используйте параметр full:

::image-figure{src="/media/screenshot.png" alt="Описание скриншота" full}
::

Не добавляйте в статьи пароли, токены, значения .env и внутренние ссылки, не предназначенные для публичного доступа.

Начало работы

Первые шаги в личном кабинете и базовые сценарии работы.

Как пользоваться навигацией

Как быстро находить разделы, статьи и связанные инструкции.