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

Docusaurs: Add more white space to the pages for readability #4575

Closed
Tracked by #4396
Jwaegebaert opened this issue Feb 24, 2023 · 6 comments
Closed
Tracked by #4396

Docusaurs: Add more white space to the pages for readability #4575

Jwaegebaert opened this issue Feb 24, 2023 · 6 comments
Labels

Comments

@Jwaegebaert
Copy link
Contributor

Jwaegebaert commented Feb 24, 2023

The current width of the documentation pages can make it difficult for users to read and understand the content. Adding more white space in the width of the pages will improve readability by allowing users to focus on the content without getting overwhelmed by the amount of text on the page. We should consider increasing the page width and adjusting the margins to create more white space. This will make it easier for users to scan the content and find the information they need.

This can likely be achieved by swizzling a Docusaurus component and modifying the styling there. Swizzling allows us to override the default behavior of a Docusaurus component and replace it with our own custom implementation. More information about swizzling in Docusaurus can be found here: https://docusaurus.io/docs/swizzling.

Note!

When making a PR for this issue, make sure you target the branch docs-migration.


Related to #4396

@Jwaegebaert
Copy link
Contributor Author

I've updated the pages so the content doesn't exceed 700px. This gives a bit of an insight into how this change will affect the pages.

Changed version:

Homepage

afbeelding

planner plan add

afbeelding

Original version:

Homepage

afbeelding

planner plan add

afbeelding

@pnp/cli-for-microsoft-365-maintainers what are your thoughts regarding this change?

@waldekmastykarz
Copy link
Member

This can likely be achieved by swizzling a Docusaurus component and modifying the styling there. Swizzling allows us to override the default behavior of a Docusaurus component and replace it with our own custom implementation. More information about swizzling in Docusaurus can be found here: https://docusaurus.io/docs/swizzling.

I like the improved version. A few questions:

  • do we need swizzling? Seems like an overly complicated solution to something that we should be able to change in the css
  • have you checked if it doesn't affect the responsive rendering on smaller screens?

@Jwaegebaert
Copy link
Contributor Author

@pnp/cli-for-microsoft-365-maintainers, what are your thoughts regarding this issue? Docusaurus has now already been live for several months and personally, I don't mind the white space that comes out of the box.

@milanholemans
Copy link
Contributor

Agree, according to me, the current margin is ok. We shouldn't add too much custom styling which could break in the future.

@martinlingstuyl
Copy link
Contributor

Same here, it's fine as it is..

@Adam-it
Copy link
Member

Adam-it commented Nov 24, 2023

same. I guess we may leave them 👍

@milanholemans milanholemans closed this as not planned Won't fix, can't repro, duplicate, stale Nov 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants