Skip to content
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

PDF Download #96

Open
peterhunn opened this issue Sep 29, 2019 · 7 comments
Open

PDF Download #96

peterhunn opened this issue Sep 29, 2019 · 7 comments

Comments

@peterhunn
Copy link
Member

Is your feature request related to a problem? Please describe.

NA

Describe the solution you'd like

I'd like to be able to download the current version of the technical specification and associated documentation in a single PDF reference

@peterhunn peterhunn added the hacktoberfest by DigitalOcean and DEV label Sep 29, 2019
@sesam
Copy link

sesam commented Oct 3, 2019

What does "associated documentation" mean here? Does this issue include creating a PDF and adding a suitably visible link to it?

@jolanglinais
Copy link
Member

@peterhunn flagging this for you.

@dselman dselman removed Good First Issue :octocat: Good for newcomers hacktoberfest by DigitalOcean and DEV labels Oct 3, 2019
@peterhunn
Copy link
Member Author

What does "associated documentation" mean here? Does this issue include creating a PDF and adding a suitably visible link to it?

The Template Spec is one component of the documentation (currently available at https://docs.accordproject.org/).

This issue involves generating a downloadable PDF representation of all of AP documentation.

N.B. As @dselman added, the documentation is flagged for significant revision under #111.

@mttrbrts
Copy link
Member

mttrbrts commented Oct 5, 2019

One approach to solving this problem would be to find a solution to converting the Docusaurus markdown content to PDF.
For example, facebook/docusaurus#969

IMO the scope should only be the contents of https://github.com/accordproject/techdocs/tree/master/docs, ideally with a way to preserve the ordering / structure of the content in Docusaurus.

If this can be done in a general way, it should be independent of the ongoing changes to the documentation structure in #111.

@jeromesimeon
Copy link
Member

I agree with @mttrbrts We should wait for that feature to be available in Docusaurus. Last time I checked it seemed to be a widely requested one, and (I think) slated for the pretty big Docusaurus 2.0 update.

@RobbiNespu
Copy link

RobbiNespu commented Oct 24, 2019

Do you use travis? we can build PDF with pandoc during build and make it available under "released" tab on github

@dselman
Copy link
Contributor

dselman commented Sep 29, 2020

It seems like the Docusaurus community is making some progress on this. E.g.
https://github.com/KohheePeace/docusaurus-pdf

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

No branches or pull requests

7 participants