👷 Simple gitaction for auto PDF creation

[fanooel]

Simple pdf auto creation from MD files (as artifact in ACTION)

Next step:

1. Implement release strategy- pdf will be created only for releases.
2. Switch to 'pandoc' or other action for MD to PDF conversion.

[MateuszNaKodach]

Bardzo dobry pomysł. Właśnie to pisałem :)

[fanooel]

Jak się pojawi koncepcja z releasami i wersjonowaniem (sugeruję auto release z auto wersjami) to mogę to przenieść to pandoca, gdzie informacje o wersji będzie np. w stopce i stronie tytułowej.

Jeśli będzie też strategia z branchem devel- można devele jako wersje robocze też generować.

No i jeszcze można dodać akcję na dodawanie linka do aktualnej wersji PDF w README :) i CHANGELOG

[fanooel]

Na deser- powiadomienia o releasach dla prawników kochających czytanie PDF

[maciejmrozinski]

Widzę, że jest nas więcej z tym pomysłem :)

[maciejmrozinski]

zmiana nazw output dla utrzymania konwencji startowej

[fanooel]

Ma razie to jest tylko do artefaktów, w Actions, więc nie ma co się za bardzo rozdrabniać w konwencji. Ostatecznie powinno to i tak lądować jako artefakt release.

[kkuriata]

Maybe stick to Polish and change images to obrazy? It would be nice to create an empty folder and place .gitkeep inside until the 1st image is created

[czlowiek488]

I would also consider removing empty spaces from file and directory names.
It may cauze unexpected results while used with software not supporting it.

[kkuriata]

It would be nice to remove already existing PDFs, because this workflow will create new ones inside wersje pdf folder

[ov-i]

Maybe let's stick to polish or english lang.

[czlowiek488]

Mam wrażenie że warto by było rozważyć zmianę konwencji położenia plików.
O ile nie spotkałem się wcześniej z projektami ustaw na githubie, to mam wrażenie że powszechnie znaną konwencją jest trzymanie plików źródłowych w roocie projektu lub folderze "src", a wygenerowane pliki w osobnym katalogu.

[MateuszNaKodach]

Mam wrażenie że warto by było rozważyć zmianę konwencji położenia plików. O ile nie spotkałem się wcześniej z projektami ustaw na githubie, to mam wrażenie że powszechnie znaną konwencją jest trzymanie plików źródłowych w roocie projektu lub folderze "src", a wygenerowane pliki w osobnym katalogu.

Jednak trzeba pamiętać, że nie tylko programiści są adresatami tego repo :) Jednakże łatwiej by pewnie było gdyby pliki .MD były jakoś łatwiej dostępne czy opisane, bo to w nich powinno się proponować zmiany. PDFy właśnie w ogóle można pewnie wywalić i publikować z tego doc (jeśli osoby mniej techniczne dadzą radę).

[czlowiek488]

@MateuszNaKodach Po twoim komentarzu zastanawiam się czy nie lepszą opcją byłoby wrzucanie plików na jakiś hosting pdf'ów. W ten sposób osoby które chcą przeczytać miałyby jeszcze prościej.
Nie sprawdzałem takiego rozwiązania wcześniej, ale - https://fliphtml5.com/ wygląda sensownie.
Ewentualnie customowa aplikacja, ale to już byłyby koszta.

[pm4rcin]

A może po prostu stworzyć stronkę z pomocą Github pages (ewentualnie dokupić domenę, żeby w wyszukiwarce wyglądało profesjonalnie) i tam by się wrzucało automatycznie pdfy z github actions? Oczywiście to by wymagało, żeby front-endowcy wymyślili dobry layout. Że np. jedna podstrona na robocze wersje (devel), coś na te otagowane na Githubie. No i przede wszystkim żeby to była statyczna strona bez Javascriptu i fajerwerków (jakiś static site generator, albo czysty html i css (tailwind?)). Może w sumie lepiej stworzyć issue, żeby tu nie śmiecić? Co o tym myślicie?

[piotrminkina]

Co do koncepcji z wydaniami i wersjonowaniem:

• Wyświetlanie PDF'ów w formie strony internetowej #112 (comment)
• Gitflow #109 (comment)

[MacDada]

previous versions of this action accepted the input_dir input. This is still accepted as input for backwards compatibility, but passing a directory as input_path now carries out the same functionality.

https://github.com/BaileyJM02/markdown-to-pdf#github-action-inputs

[MacDada]

biorąc pod uwagę, że w projekcie nie ma żadnych obrazków -> może konfigurację dla obrazków można pominąć?

[dotevo]

PDF to format binarny i nie jest zbyt wygodny do wersjonowania ponieważ nie da się zobaczyć na nim git diff pomiędzy wersjami. Czy jest sens pchać to do Git repo? Może lepiej trzymać to w release z wygenerowaną sumą kontrolną i tyle - to trochę tak jakby pchać wygenerowane pliki "exe" na githuba.

[Jakubk15]

A może po prostu stworzyć stronkę z pomocą Github pages (ewentualnie dokupić domenę, żeby w wyszukiwarce wyglądało profesjonalnie) i tam by się wrzucało automatycznie pdfy z github actions? Oczywiście to by wymagało, żeby front-endowcy wymyślili dobry layout. Że np. jedna podstrona na robocze wersje (devel), coś na te otagowane na Githubie. No i przede wszystkim żeby to była statyczna strona bez Javascriptu i fajerwerków (jakiś static site generator, albo czysty html i css (tailwind?)). Może w sumie lepiej stworzyć issue, żeby tu nie śmiecić? Co o tym myślicie?

VitePress raczej by się sprawdził

[MacDada]

Wie ktoś może jak ustawić czcionkę szeryfową dla generowanego PDFa? @fanooel ?

[gajosadrian]

Osobiście uważam, że czcionki szeryfowe są jednymi z gorszymi do czytania dlatego pozostałbym przy tym co jest. A finalnie to i tak te Ustawy będą ręcznie obrabiane w Word 🙂.

Aktualnie używany skrypt baileyjm02/markdown-to-pdf@v1.2.0 nie umożliwia bezpośredniego ustawienia czcionki, ale możemy go zastąpić innym narzędziem, które obsługuje niestandardowe czcionki.

Nie jestem ekspertem w GitHub Workflows ale można spróbować z tym:

- name: Install wkhtmltopdf
  run: sudo apt-get install -y wkhtmltopdf

- name: Install fonts
  run: sudo apt-get install -y fonts-dejavu-core

- name: Convert to PDF
  run: |
    cd wersze\ tekstowe
    find . -name '*.md' -type f -exec sh -c 'wkhtmltopdf --enable-local-file-access --margin-top 0mm --margin-right 0mm --margin-bottom 0mm --margin-left 0mm --page-size A4 --no-background --no-outline --dpi 300 --footer-spacing 0 -T 0mm -R 0mm -B 0mm -L 0mm --header-spacing 0 -t pdf --encoding utf-8 --quiet --quiet "{}" "../wersze pdf/{}.pdf"' \;

[fanooel]

@gajosadrian jak już to lepiej użyć pandoca, gdzie możesz zrobić własny template w TEXie i nawet pododawać załączniki, spisy treści, nagłówki, stopki i co tam chcesz. Od biedy można tym też eksportować do odt czy worda :)

[Jakubk15]

Ewentualnie można generować PDF'y za pomocą tego skryptu w GitHub Actions, ale nie wersjonować tego w repozytorium, tylko jako artefakt w Actionsach i przy wydaniu wersji (release).

[MacDada]

Wdrożyliśmy w końcu nieco bardziej rozbudowaną wersję z automatycznymi release i generowaniem PDFów przy pomocy Pandoca i LaTeXa (dają większe możliwości konfiguracji).

Dziękujemy za propozycje i sugestie!