Skip to content
New issue

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

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

Already on GitHub? # to your account

Generated PDF examples in README and tutorial #50

Open
epogrebnyak opened this issue Aug 15, 2023 · 1 comment
Open

Generated PDF examples in README and tutorial #50

epogrebnyak opened this issue Aug 15, 2023 · 1 comment

Comments

@epogrebnyak
Copy link

PDFje seems a great project in the making, congrats and good luck in making it happen. As a new user on the README for me it is interesting to see the ouput of PDFje. I think these files would be very pretty and attractive given the effort you invested in typography. A PDF link in readme can attract more people to the project.

Also adding inline markdown would be a killer feature. So far most workflows seem to be "md -> html -> pdf", but native and nice looking md-to-PDF is a game-changer.

Also as a new user, It wouldbe nice to have something in between a one-liner and a tutorial example (which is a bit too much code for a first-time user). Also downloading the resulting PDFs in tutorial is a matter of trust things work. Great if tutorial examples can be copy-and-run (I think they are not due to local paths, also constants-before-code makes the examples not so easy to read).

I know it is easier to point things inopen source, rather than do things, so I'd be interested in doing some work for the project - eg a bit of additions and clarifications to documentation.

@ariebovenberg
Copy link
Owner

👋 Hi @epogrebnyak and thanks for the kind words. Your feedback is very welcome.

  • I'm very happy you see the potential of the md-to-PDF feature, it's definitely on my radar — especially since there have lately been so many improvements and extensions to the markdown format, like see MyST. A big hurdle, I expect, is that a lot of thought will be needed to provide a good markdown extension/dialect that supports fonts/colors/indents and the other things PDF documents can do.
  • Agreed that there should probably be an actual PDF sample 😅 . It also makes sense to have a few in-between full examples. Examples are great, we should do more of those 👀.

Thanks for taking the time to write up these suggestions. "pointing to things" is actually just what is needed now 👍

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

No branches or pull requests

2 participants