Как превратить README проекта в PDF
README хорошо выглядит на платформе для хостинга кода, но клиенты, рецензенты и отделы закупок часто просят документацию проекта в PDF для архива. Это руководство превращает файл Markdown в аккуратный документ без каких-либо инструментов сборки.
PDF сохраняет структуру README, поэтому заголовки, списки, таблицы и блоки кода выглядят так, как их расположил автор.
Шаг за шагом
Получите файл README
Скачайте README.md из репозитория или сохраните его из редактора. Принимаются файлы до 1 МБ.
Конвертируйте
Откройте README в PDF и выберите файл. Настроек нет; заголовки, списки, таблицы и блоки кода оформляются автоматически.
Проверьте изображения
Изображения, указывающие на веб-адрес, не загружаются. Если README опирается на снимки экрана, добавьте их позже отдельными страницами.
Объедините с другими документами
Откройте Объединить PDF и добавьте PDF с README вместе с другими файлами, например лицензией, журналом изменений или схемой архитектуры.
Пронумеруйте страницы
Откройте Добавить номера страниц в PDF и выберите формат и положение, чтобы рецензенты могли указать точную страницу.
Инструменты в этой инструкции
Вопросы об этой задаче
- Можно ли конвертировать несколько файлов Markdown?
- Конвертируйте каждый файл отдельно, а затем объедините результаты с помощью Объединить PDF в нужном порядке.
- Появятся ли значки и внешние изображения?
- Нет. Изображения по ссылкам из интернета пропускаются, поэтому значки исчезают. Окружающий их текст остаётся.
- Отправляется ли мой README на сервер?
- Конвертация работает на защищённом сервере, который удаляет файл сразу после отправки PDF. Объединение и нумерация работают в браузере.