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.

Sign up for GitHub

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

Jump to bottom

Improvements to pdf generation script #47

Merged
merged 116 commits into from
Nov 11, 2024
Merged

Improvements to pdf generation script #47

merged 116 commits into from
Nov 11, 2024

Conversation

yestalgia
Copy link
Collaborator

This PR enhances the QLC+ documentation PDF generation script with the following updates:

  1. Cover Page: Added a professional cover page with project title, version, date, and relevant logos.
  2. Styling: Improved overall styling for a more consistent and attractive appearance, including fonts and layout.
  3. Table of Contents: Optimized the TOC by limiting its depth for easier navigation.
  4. Bookmarks: Included bookmarks in the PDF for quick access to major sections.
    Note: Section breaks couldn't be improved due to Pandoc's limitations with markdown pages.

These changes significantly improve the readability and visual appeal of the documentation.

Closes #46

yestalgia added 30 commits July 7, 2024 18:46
@yestalgia
Add: Pandoc pdf build system. This seems to work the best based on my…
9a8fbc3 
… testing.
@yestalgia
Fix: image path
f6f7318
@yestalgia
Fix: Use full path for input file
3b97d09
@yestalgia
Fix: move images so they can be referenced by pandoc
a5a8289
@yestalgia
Chore: Try different docker image
077d26f
@yestalgia
Fix: Undefined control sequence error
d1d542d 
jgm/pandoc#6595
@yestalgia
Fix: Pandocs giving me shit about non-ascii characters
a710c71
@yestalgia
Fix use a PDF engine that understands unicode
68ce491
@yestalgia
Add: Template, Paper size, Margin
31658df
@yestalgia
Fix: Eisvogel is not compatible with lualatex
1449325
@yestalgia
Chore: Attempt to force cover page
2e8b2b1
@yestalgia
Chore: Attempt table of contents
4dafcf5
@yestalgia
Fix: Mainwindow screenshot, naming of chapters
d3def4a
@yestalgia
Fix: Heading levels
f56b41e
@yestalgia
Fix: Apple serial page heading styles
ca25f0e
@yestalgia
Attempt: sans-serif fonts
9b5fcd2
@yestalgia
Fix: Use Source Sans Pro for font
ab20701
@yestalgia
Add: LaTeX template to make things pop
5c9e226
@yestalgia
Fix: VSCode not playing nice with my gitignore
7287bb9
@yestalgia
Fix: File path not working
10a3280
@yestalgia
Fix: copy instead of moving image folder to allow people to view the …
afc3324 
…markdown content
@yestalgia
Remove: Unused latex template
da5ef5a
@yestalgia
Chore: Attempt title page colour
d8e98a0
@yestalgia
Fix: Copy recursive
325195c
@yestalgia
Add: TitlePage V2
824db7b
@yestalgia
Fix: Metadata date
8deeccd
@yestalgia
Fix: Metadata date again
a345991
@yestalgia
Add: Stage to get date
fcf0ddb
@yestalgia
Fix: I'm silly
d30d69c
@yestalgia
Add: License
b096c22
@yestalgia yestalgia force-pushed the 46-improve-pdf-generation-script branch from 0ec1007 to 5507055 Compare September 29, 2024 04:29
@yestalgia yestalgia marked this pull request as ready for review November 11, 2024 22:54
@yestalgia yestalgia merged commit ee33390 into main Nov 11, 2024
4 checks passed
@yestalgia yestalgia self-assigned this Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@yestalgia yestalgia

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve PDF Generation Script for Offline Documentation
1 participant
@yestalgia