Skip to content

Collate markdown docs into a PDF document with pandoc #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2023

Conversation

stmio
Copy link
Contributor

@stmio stmio commented Apr 26, 2023

Adds a GitHub Action which collates all markdown documentation files into a single PDF doc, see #3 (comment). The action runs on every commit and uses pandoc to generate the document, which outputs the file to GitHub Artifact storage.

The main downside of this document in comparison to the website is that the GIF animations display as static images.

I am happy to maintain this action into the future, let me know if you find any problems. 😄

Closes #3

@dacap dacap self-assigned this Apr 27, 2023
@dacap
Copy link
Member

dacap commented Apr 27, 2023

Hi @stmio, thanks a lot for this PR! I've checked the PDF output and it looks great for a first draft, as you said the main problem with this is not having the GIF animations (one reason I didn't dedicate time to this was that, and we probably will be more video/GIF intensive in the future).

Anyway this can be available in case someone find it useful. I'm not sure if there is a way to sort chapters, but probably "51 Aseprite Help" should be the first one (as it's the overview).

I'll merge it right now. Thanks again!

@dacap dacap merged commit d25c72e into aseprite:main Apr 27, 2023
@stmio
Copy link
Contributor Author

stmio commented Apr 27, 2023

No problem, thank you! I will have a look into making some improvements soon. 😄

At the moment, the chapters are sorted alphabetically by file name (due to using *.md), followed by the files in ./extensions/ at the end. I'll have a look at adjusting the order.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PDF version of docs
2 participants