Категории

GitHub README в PDF

Получает README с GitHub и рендерит в PDF

Создайте PDF из GitHub README.

Источник:

  • URL репозитория или owner/repo
  • Доп. ветка и путь README

Вывод:

  • Оформление в стиле GitHub и параметры печати

Примеры результатов

1 Примеры

Пример: GitHub README to PDF

Автоматически созданный PDF-пример: Repository README converted to PDF

github-readme-to-pdf-example1.pdf Показать файл
Показать параметры ввода
{ "repository": "https://github.com/meilisearch/meilisearch", "theme": "print", "baseFontSize": 13 }

Ключевые факты

Категория
Document Tools
Типы входных данных
text, select, number, checkbox
Тип результата
file
Покрытие примерами
4
API доступен
Yes

Обзор

Инструмент для быстрого преобразования файлов README из любого публичного репозитория GitHub в профессиональный PDF-документ с сохранением оригинального форматирования.

Когда использовать

  • Для создания офлайн-копий документации проекта для архивации.
  • Для подготовки печатных версий руководств пользователя или описаний библиотек.
  • Для включения актуальной документации в отчеты или презентации в формате PDF.

Как это работает

  • Введите URL репозитория или укажите его в формате 'владелец/репозиторий'.
  • При необходимости укажите конкретную ветку и путь к файлу README.md.
  • Настройте параметры страницы, поля и тему оформления для получения нужного вида.
  • Запустите процесс конвертации и скачайте готовый PDF-файл.

Сценарии использования

Создание печатных руководств по установке ПО для технических специалистов.
Архивация документации проекта для соответствия внутренним стандартам отчетности.
Подготовка красивых PDF-версий README для отправки клиентам или коллегам.

Примеры

1. Создание PDF-руководства для проекта

Технический писатель
Контекст
Необходимо подготовить документацию проекта для передачи заказчику в формате PDF.
Проблема
Ручное копирование текста из GitHub нарушает верстку и теряет стили.
Как использовать
Вставить ссылку на репозиторий, выбрать тему 'print' и настроить поля для печати.
Пример конфигурации
repository: https://github.com/meilisearch/meilisearch, theme: print, baseFontSize: 13
Результат
Готовый PDF-документ с профессиональным оформлением, готовый к печати или отправке.

Проверить на примерах

markdown, pdf

Связанные хабы

FAQ

Нужно ли авторизоваться в GitHub?

Нет, инструмент работает с публичными репозиториями без необходимости входа в аккаунт.

Можно ли изменить размер шрифта?

Да, вы можете настроить базовый размер шрифта в диапазоне от 10 до 20 пикселей.

Поддерживаются ли другие форматы, кроме A4?

Да, доступны форматы A4, Letter, Legal и A5.

Как настроить поля в документе?

Вы можете вручную задать отступы сверху, снизу, слева и справа в миллиметрах.

Что делает опция 'Печать фона'?

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

Документация API

Конечная точка запроса

POST /ru/api/tools/github-readme-to-pdf

Параметры запроса

Имя параметра Тип Обязательно Описание
repository text Да -
branch text Нет -
readmePath text Нет -
theme select Нет -
baseFontSize number Нет -
pageSize select Нет -
landscape checkbox Нет -
printBackground checkbox Нет -
marginTop number Нет -
marginBottom number Нет -
marginLeft number Нет -
marginRight number Нет -
waitUntil select Нет -
waitTime number Нет -

Формат ответа

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Файл: Файл

Документация MCP

Добавьте этот инструмент к конфигурации сервера MCP:

{
  "mcpServers": {
    "elysiatools-github-readme-to-pdf": {
      "name": "github-readme-to-pdf",
      "description": "Получает README с GitHub и рендерит в PDF",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=github-readme-to-pdf",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Вы можете объединять несколько инструментов, например: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, максимум 20 инструментов.

Если вы столкнулись с проблемами, пожалуйста, свяжитесь с нами по адресу [email protected]