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

add toc functionality #27

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

add toc functionality #27

wants to merge 1 commit into from

Conversation

bojl
Copy link

@bojl bojl commented Mar 25, 2021

This PR adds toc functionality to docusaurus-pdf.

To add a toc to your pdf, simply add <toc/> anywhere in your documentation; the script will insert the toc at that location. Each header element in the documentation will be added to the table of contents, indented (header level - 1) * 20 pixels.

This PR slightly reworks how the end pdf is generated. Rather than converting each page to a pdf buffer, then merging the pdf buffers into a final pdf, script will now convert each page to html, join the html, then convert to pdf via puppeteer. This is because internal links do not work with the pdf-lib library.

EDIT: it seems like tests are failing for unrelated reasons

@kohheepeace
Copy link
Owner

kohheepeace commented Mar 26, 2021

@bojl thanks for your PR. I will check it asap.
And can you share generated PDF example??

@kohheepeace kohheepeace self-requested a review March 29, 2021 07:23
@kohheepeace
Copy link
Owner

@bojl I checked the generated TOC, amazing feature 😁 👍

I have a question

How can I make only toc page ?

I have putted the <toc /> under first page title, and the output is like the below image.
2021-03-31_01h55_44

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.

3 participants