Создание PDF-файлов из Markdown с помощью Pandoc и LaTeX

PDFJam

В зависимости от того, как вы установили LaTeX, у вас может быть уже установлен PDFJam. (Проверьте, набрав, which pdfjam в терминале.) Если у вас его нет, найдите подробности по установке здесь .

Процесс сборки

После некоторых размышлений сценарий bash, который я запускаю локально, пока кажется лучшим вариантом. Существуют лучшие методы, но они работают, и я могу улучшить процесс позже, перенеся его в систему непрерывной интеграции или в Git Hooks.

Посмотрите скрипт bash на GitHub .

Давайте теперь пройдемся по этому сценарию.

Настроить

 bundle install bundle update rm -dfr _site rm -dfr pod 

Эти команды гарантируют, что зависимости Ruby, необходимые Jekyll для создания веб-сайта, являются актуальными, и что мы удаляем все существующие веб-сайты и папки для печати.

Создайте сайт

 jekyll build mkdir -p pod/pdf/cards 

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

Создание PDF-файлов из Markdown

Давайте создадим папку, содержащую PDF-версию каждого файла Markdown:

 for filename in _cards/*.md; do echo $filename pandoc --from=markdown+yaml_metadata_block --template _layouts/cards.latex -o pod/pdf/cards/"$(basename "$filename" .md)".pdf --latex-engine=xelatex $filename done 

Сценарий обрабатывает каждый файл Markdown в каталоге _cards , _cards соблюдением полей фронта Markdown. Используя шаблон cards.latex (мы рассмотрим это далее), правильный движок LaTeX выводит PDF-файл с соответствующим именем.

Файл LaTeX

Большая часть волшебства для создания файлов карт из Pandoc происходит в шаблоне LaTeX .

Просмотрите шаблон LaTeX на GitHub .

LaTeX является новым для меня, но это не слишком сложно. Я объясню, что я изменил из файла LaTeX по умолчанию (находится в Pandoc_install_dir/data/templates/default.latex ), чтобы заставить работать карты. Я рекомендую sharelatex.com для предварительного просмотра файлов LaTeX при их редактировании.

 \usepackage[paperheight=9.0cm,paperwidth=5.7cm,margin=0.5cm]{geometry} % Set page size \usepackage{multicol} % We need column layouts \usepackage{amsthm,amsmath,amssymb} \usepackage{graphicx} % We want images in our layout \graphicspath{{/Users/chrisward/Workspace/cs_jk/_site/assets/images/cards/}} % Where are images located \usepackage{float} \usepackage[utf8]{inputenc} \usepackage{fontspec} \setmainfont{VT323} % We want to use a custom font installed on our local system, so add that package and select the font 

Нам нужен определенный размер страницы, и мы будем использовать столбцы позже для определения стоимости и количества карт. Мы используем графику и пользовательские шрифты, поэтому нам нужны эти пакеты .

Мы пытаемся создать простой макет, понятный и беспрепятственный. Вот как мы это сделали:

 \begin{document} \begin{flushright} {$title$} \end{flushright} $if(image)$ \begin{figure}[H] \centering \includegraphics[height=2cm]{$image$} \end{figure} $endif$ \begin{flushleft} \scriptsize{$body$} \end{flushleft} \scriptsize \begin{tabular}{ ll } Costs & Scores \\ $if(staffcost)$ Staff: {$staffcost$} $endif$ & $if(loyaltyscore)$ Loyalty: {$loyaltyscore$} $endif$ \\ $if(rdcost)$ RandD: {$rdcost$} $endif$ & $if(profitscore)$ Profit: {$profitscore$} for {$profitlength$} turns $endif$ \\ $if(marketingcost)$ Marketing: {$marketingcost$} $endif$ & $if(longevityscore)$ Longevity: {$longevityscore$} $endif$ \\ $if(longevitycost)$ Longevity: {$longevitycost$} $endif$ & \\ $if(moneycost)$ Money: {$moneycost$} $endif$ & \end{tabular} \begin{flushleft} $if(specialscore)$ Special: {$specialscore$} $endif$ \end{flushleft} \begin{center} $if(legal)$ \tiny{$legal$} $endif$ \end{center} \end{document} 

Я чувствую, что многое из вышесказанного достаточно понятно для любого, кто использовал код или разметку. Мы создаем элементы карты, выравниваем их, устанавливаем размеры шрифтов и проверяем, есть ли значения перед их выводом, чтобы карта не заканчивалась пустыми полями.

Мы изменяем размеры изображения до определенного размера и центрируем его. Значения затрат и баллов представлены в виде двух столбцов, которые задаются командой begin{tabular} а количество столбцов — числом l s.

Объединение карт на одной странице

Мы используем PDFJam для создания большого файла PDF, объединяющего каждую из отдельных карт PDF:

 pdfjam pod/pdf/cards/*.pdf --no-landscape --frame true --nup 3x3 --suffix complete --outfile ./cards.pdf mv cards pod/cards_complete.pdf 

С помощью этой команды мы уточним следующее:

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

PDFJam может выдавать сообщение об ошибке, если вы не выводите его в рабочий каталог, поэтому я переместил файл туда, где я на самом деле его хочу (надеюсь, это будет решено в будущем). Здесь мы также можем удалить отдельные файлы PDF, если мы не хотим их.

И это все — у нас есть веб-сайт и печатный PDF с карточками игр.

Запуск сценария

Я запускаю скрипт сборки с помощью ./build.sh . Поскольку обработка изображений и PDF занимает много времени, это занимает от пяти до десяти минут. Затем у меня есть отдельный скрипт, который развертывает эти папки на веб-сервере.

Что дальше

Этот процесс занял у меня некоторое время, чтобы разобраться в этом, но теперь он достаточно хорош, чтобы двигаться вперед и оттачивать процесс и макеты после игрового тестирования.

Я надеюсь, что вы найдете мои исследования и эксперименты полезными для ваших проектов. Пожалуйста, дайте мне знать, если у вас есть какие-либо комментарии или предложения.