Skip to content

doc: adjusting formatting when printing - #24325

Closed
tlhunter wants to merge 1 commit into
nodejs:masterfrom
tlhunter:print-css
Closed

doc: adjusting formatting when printing#24325
tlhunter wants to merge 1 commit into
nodejs:masterfrom
tlhunter:print-css

Conversation

@tlhunter

@tlhuntertlhunter commented Nov 12, 2018

Copy link
Copy Markdown
Contributor

As a weekend project I built a PDF generator for the Node.js docs. This project required making small changes to the documentation CSS for aesthetics. Take a look at these PDF files to view the CSS changes in action.

Here's an overview of these changes:

  • reduce page margin
  • remove emphasis from links as they're unclickable
    • i.e. color, and underlines when in deprecated block
  • hides expandable > history items since they're collapsed and unreadable
    • alternative: I can make these always expanded instead
  • removes horizontal scrollbar from bottom of print output
  • reduce stability rectangle sizes
    • normally they're full width, now they're as wide as the text
  • shrink all text and headlines slightly
    • they're now closer to what you'd find in a book
  • hide ToC
    • it takes up many many pages and is ultimately unclickable
Checklist

@tlhunter
doc: adjusting formatting when printing
b1a5028
- reduces page margins
- removes emphasis from links
- hides expandable history items
- removes horizontal scrollbar from bottom of print output
- reduce stability rectangle sizes
- shrink headlines slightly
- hide ToC (as it's unclickable when printed)
Ref: https://thomashunter.name/nodejs-documentation-pdf
@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 12, 2018
@tlhunter

tlhunter commented Nov 12, 2018

Copy link
Copy Markdown
ContributorAuthor

/cc @refack

@refack

refack commented Nov 12, 2018

Copy link
Copy Markdown
Contributor

Hello @tlhunter and thank you for the contribution!

@refack

refack commented Nov 12, 2018

Copy link
Copy Markdown
Contributor

Lite CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1586/

I'll setup a demo site so we can compare the generated docs.

@tlhuntertlhunter mentioned this pull request Nov 12, 2018
Open
@Trott

Trott commented Nov 17, 2018

Copy link
Copy Markdown
Member

@nodejs/website

@Trott

Trott commented Nov 17, 2018

Copy link
Copy Markdown
Member

Since these are all under @media print, I think they're all pretty safe. And as you're actually generating PDFs and making them available to the public for offline use, I think you've got a pretty solid stake as a primary use case.

LGTM

Trott pushed a commit to Trott/io.js that referenced this pull request Nov 17, 2018
@tlhunter@Trott
doc: adjusting formatting when printing
344a46a
- reduces page margins
- removes emphasis from links
- hides expandable history items
- removes horizontal scrollbar from bottom of print output
- reduce stability rectangle sizes
- shrink headlines slightly
- hide ToC (as it's unclickable when printed)
Ref: https://thomashunter.name/nodejs-documentation-pdf
PR-URL: nodejs#24325
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
@Trott

Trott commented Nov 17, 2018

Copy link
Copy Markdown
Member

Landed in 344a46a

@TrottTrott closed this Nov 17, 2018
@refack

refack commented Nov 17, 2018

Copy link
Copy Markdown
Contributor

Post land visual test:
Pre:
https://nodejs.org/download/nightly/v12.0.0-nightly2018111662d053b707/docs/api/assert.html
Post:
https://nodejs.org/download/nightly/v12.0.0-nightly20181117344a46ad03/docs/api/assert.html

Screenshot of print preview:

Pre:

image

Post:

image

@refack

refack commented Nov 17, 2018•
edited
Loading

Copy link
Copy Markdown
Contributor

Maybe we can follow up with an improvement to the visual of class="api_stability api_stability_2"

@WaleedAshraf

WaleedAshraf commented Nov 17, 2018

Copy link
Copy Markdown
Contributor

I see this in print preview on chrome using @refack links.

Pre:

screenshot 2018-11-17 at 11 09 08 pm

Post:

screenshot 2018-11-17 at 11 09 26 pm

@refack

refack commented Nov 17, 2018

Copy link
Copy Markdown
Contributor

I see this in print preview on chrome using @refack links.

@WaleedAshraf Do you have "Background Graphics" checked?
image

@WaleedAshraf

WaleedAshraf commented Nov 18, 2018

Copy link
Copy Markdown
Contributor

@refack Got it.
Yup, with "Background graphics" it's the same view as you posted above.

targos pushed a commit that referenced this pull request Nov 18, 2018
@tlhunter@targos
doc: adjusting formatting when printing
165d790
- reduces page margins
- removes emphasis from links
- hides expandable history items
- removes horizontal scrollbar from bottom of print output
- reduce stability rectangle sizes
- shrink headlines slightly
- hide ToC (as it's unclickable when printed)
Ref: https://thomashunter.name/nodejs-documentation-pdf
PR-URL: #24325
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
@tlhunter
tlhunter deleted the print-css branch November 19, 2018 02:25
rvagg pushed a commit that referenced this pull request Nov 28, 2018
@tlhunter@rvagg
doc: adjusting formatting when printing
81ec97b
- reduces page margins
- removes emphasis from links
- hides expandable history items
- removes horizontal scrollbar from bottom of print output
- reduce stability rectangle sizes
- shrink headlines slightly
- hide ToC (as it's unclickable when printed)
Ref: https://thomashunter.name/nodejs-documentation-pdf
PR-URL: #24325
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
@BridgeARBridgeAR mentioned this pull request Dec 5, 2018
Merged
4 tasks
This was referenced Dec 7, 2018
Closed
Closed
Closed
Closed
Closed
codebytere pushed a commit that referenced this pull request Jan 12, 2019
@tlhunter@codebytere
doc: adjusting formatting when printing
016ac8b
- reduces page margins
- removes emphasis from links
- hides expandable history items
- removes horizontal scrollbar from bottom of print output
- reduce stability rectangle sizes
- shrink headlines slightly
- hide ToC (as it's unclickable when printed)
Ref: https://thomashunter.name/nodejs-documentation-pdf
PR-URL: #24325
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
@codebyterecodebytere mentioned this pull request Jan 15, 2019
Merged
codebytere pushed a commit that referenced this pull request Jan 29, 2019
@tlhunter@codebytere
doc: adjusting formatting when printing
e11d46c
- reduces page margins
- removes emphasis from links
- hides expandable history items
- removes horizontal scrollbar from bottom of print output
- reduce stability rectangle sizes
- shrink headlines slightly
- hide ToC (as it's unclickable when printed)
Ref: https://thomashunter.name/nodejs-documentation-pdf
PR-URL: #24325
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
This was referenced Jan 29, 2019
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benglbenglbengl approved these changes
@TrottTrottTrott approved these changes

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@tlhunter@refack@Trott@WaleedAshraf@bengl@nodejs-github-bot