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

Improve layout and readability #225

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

CasperSocio
Copy link

Here are some suggestions on how to improve the layout and readability of the <article> contents.

Tested on small viewports.

Features

  • Added CSS custom properties as an easy-to-change overview. Tweaks can easily be made at the top of the file.

Changes

  • <article>
    • Setting a max-width of 80 characters helps readability as the text is better grouped together.
    • Added 16px of horizontal padding to avoid text touching the screen edge on small viewports.
    • Center aligning the element makes the entire layout nicer to look at.
  • <figure>
    • Removed spacing around element. This is purely aesthetic.
  • <ol>, <ul>
    • Decreased the amount of indentation on list items. This is purely aesthetic.
  • <p>
    • Increased the line height to 1.5, making blocks of text more legible.
  • <pre> & <code>
    • Making the style of code examples identical to GitHub makes it more familiar and readable to developers.
    • To avoid confusion with text wrapping on smaller screens, I added horizontal scrolling.

@CasperSocio
Copy link
Author

Attach to #83

@CasperSocio
Copy link
Author

I am open to help make more substantial changes to the UI. Just let me know.

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.

1 participant