getgrav / getgrav/grav-learn

Increase readibility with smaller font-size

Open
#293 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
248
Forks
752
Avg merge
1d 6h
Merged PRs (30d)
8

Description

First of all, thanks for a great project with some very nice docs!

What I've found when referring to the documentation however, is that I often miss things in the text because of its pretty large font-size, even on smaller screens. To increase readability, I'd like to propose that the body text's `font-size` is decreased from `18px` to `14px`, and that a `max-width` of about `900px` is set on the content container.

Ideally, I'd also like for the headings to be a bit smaller as well, and for the `

` to be less dramatic. I realize that the `

` uses the identity style of Grav, but for the docs, I think that the argument to first and foremost make them easily digestible carries a lot of weight.

When trying out these changes in my browser, I must say that that they really made the docs a lot more readable to me. I've attached a screenshot showing what it looks like.

![screenshot 2016-07-07 11 03 25](https://cloud.githubusercontent.com/assets/1101677/16648261/71e9ccfa-4433-11e6-87a3-1d792f4652a8.png)

If you like, I could submit a PR for these changes!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the stylesheet that controls the documentation body, content container, and headings; no file or test is named in the issue. Compare the current rendering with the proposed 14px body text and roughly 900px content width, then verify the heading adjustments across representative documentation pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
design, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.