Всем привет! Меня зовут Катя, я развиваю Gramax, open source-платформу для управления технической документацией.

В нашем чате и у пользователей регулярно встает вопрос переезда в Gramax c других платформ. Переезд с Confluence и Notion мы сделали прямо в интерфейсе приложения, а с Yandex Wiki — отдельной утилитой.

Нет, мы не поленились, просто заметили, что сообщество Yandex Wiki такое давно просит:

• Пример 1 (367 голосов).

• Пример 2 (874 голоса).

В этой статье расскажем, как воспользоваться утилитой и выгрузить всю свою документацию из Yandex Wiki в обычный Markdown.

Что потребуется

1. Node.js версии 18 или выше (необходим для работы CLI).

2. Текстовый редактор, например Visual Studio Code.

3. Терминал.

Шаг 1. Установка Gramax CLI

Gramax CLI можно использовать двумя способами: без установки через npx или с глобальной установкой.

• Без установки. Для использования выполните: npx gramax-cli <command> [options].

• Глобальная установка. Для регулярного использования выполните: npm install -g gramax-cli.

После этого команды CLI доступны из любой папки.

Шаг 2. Получение данных из Yandex Wiki

1. Откройте Yandex Wiki и войдите в систему.

2. Нажмите F12, чтобы открыть консоль разработчика.

3. Перейдите на вкладку Network → Fetch/XHR.

4. В левой панели выберите любую статью. В консоли появится запрос getPageDetails.

5. Щелкните правой кнопкой мыши на запросе → Копировать → Копировать как fetch (Node.js).

6. Сохраните скопированный код в текстовом файле.

Шаг 3. Настройка Gramax CLI

1. Создайте файл gramax.config.yaml в рабочей директории.

2. Вставьте в него шаблон конфигурации.

   import:
      yandex:
         headers:
               "x-csrf-token": "your-csrf-token"
               "x-org-id": "your-org-id"
               cookie: "your-cookie-string"
               "x-collab-org-id": "optional-collab-org-id"

3. Заполните шаблон данными, которые скопировали из Yandex Wiki в шаге 2. Пример заполненного шаблона:

   import:
      yandex:
         headers:
               "x-csrf-token": "e8399826638e73245k0f1cfe5a944b87683bbs10:1754349881"
               "x-org-id": "1331068"
               cookie: "yandexuid=8626904001695300517; yuidss=8626904001695300517; gdpr=0; _ym_uid=1695303700525969138; yandex_login=name@name.ru;...924b99683bbb10%33878179541"
               "x-collab-org-id": "cf3c7652-ae27-455f-a126-9de4f12cegaa"

4. Сохраните файл.

Параметр x-collab-org-id не обязателен. Если у вас этого значения нет, просто не указывайте данный параметр.

Шаг 4: Запуск

Откройте консоль и выполните команду:

npx gramax-cli import yandex-wiki --destination <path> --config <path> [--raw]

Где:

• --destination, -d — путь до папки, в которую экспортируются статьи из Yandex Wiki.

• --config, -c — путь до папки, в которой лежит файл gramax.config.yaml.

• --raw, -r — параметр, который выключает трансформацию Markdown под формат Gramax. Если указан — статьи экспортируются в разметке Yandex Wiki. Если не указан — в разметке Gramax.

Результат

• В указанной директории создастся папка yandex-wiki-catalog.

• Каждая статья сохранится как Markdown-файл.

• Изображения и диаграммы экспортируются как отдельные файлы рядом с соответствующими статьями.

Что такое Gramax и зачем это все

Рассказываем о Gramax и его возможностях в статье «От Docs as Code к Everything as Code: как Gramax меняет работу с документацией». Еще подробнее:

• Смотрите наш сайт — https://gram.ax

• Проверяйте исходники в GitHub и GitVerse.

• Вступайте в комьюнити — https://t.me/gramax_chat