search

imfing / hextra

🔯 Modern, batteries-included Hugo theme for creating beautiful doc, blog and static websites
https://imfing.github.io/hextra/
MIT License
757 stars 177 forks source link

DOC: Add pdf shortcode documentation #418

Closed ShaharNaveh closed 3 months ago

ShaharNaveh commented 5 months ago

Added missing documentation for the pdf shortcode.

I was conflicted whether to use an external URL or reference a path for the example. On one hand it's more stable to include a sample pdf file in the repo and referencing it from the example, but on the other hand adding a few bytes for each git clone from now on can hurt the performance of CI/CD pipelines.

Ended up with using an external URL, but it won't be difficult changing it.

Another more "stable" option is to upload the sample pdf file to a github comment and to reference that URL instead of a completely external one.

netlify[bot] commented 5 months ago

Deploy Preview for hugo-hextra ready!

Name Link
Latest commit ff565f207773c8f2803a6552c657af51f7e9ab30
Latest deploy log https://app.netlify.com/sites/hugo-hextra/deploys/667eb050eaa4510008ba93bd
Deploy Preview https://deploy-preview-418--hugo-hextra.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

imfing commented 5 months ago

Thanks, will take a look

imfing commented 3 months ago

thanks, I included your change in #441 where I put the pdf shortcode in Others section.