Codeberg/Documentation
42
199
Fork
You've already forked Documentation
161

Reducing line width of documentation #183

Closed
opened 2021年12月04日 13:05:16 +01:00 by lukaskluge · 2 comments
Contributor
Copy link

Hi,
I want to suggest to reduce the line width of the documentation to increase readability. There's a design rule of thumb to have a max line width of ~70 characters, and I think it would help with the readability of the documentation.
I'm not sure if it should apply to pictures though, as that would decrease readability, and I think it looks ok with full width pictures, even if the text is more narrow.
I know very little about CSS but I think
.content :not(img) { max-width: 80ch; }
in the codeberg-docs.css works well.
Should I go ahead and file a pull request?

Hi, I want to suggest to reduce the line width of the documentation to increase readability. There's a design rule of thumb to have a max line width of ~70 characters, and I think it would help with the readability of the documentation. I'm not sure if it should apply to pictures though, as that would *decrease* readability, and I think it looks ok with full width pictures, even if the text is more narrow. I know very little about CSS but I think `.content :not(img) { max-width: 80ch; }` in the codeberg-docs.css works well. Should I go ahead and file a pull request?
Author
Contributor
Copy link

This makes the copyright notice in the bottom move in from the right as well, which is ok, but not ideal. Anyone got an idea how to avoid this?

This makes the copyright notice in the bottom move in from the right as well, which is ok, but not ideal. Anyone got an idea how to avoid this?
Contributor
Copy link

This would also be great to make space for a table of contents (#24) on the right. Feel free to submit a PR.

This makes the copyright notice in the bottom move in from the right as well, which is ok, but not ideal. Anyone got an idea how to avoid this?

Maybe you could add a custom style to override the max-width, or move it outside the content. Here's where it is in the templates. Though don't worry about this, it looks fine for now without the Table of Contents.

This would also be great to make space for a table of contents (#24) on the right. Feel free to submit a PR. > This makes the copyright notice in the bottom move in from the right as well, which is ok, but not ideal. Anyone got an idea how to avoid this? Maybe you could add a custom style to override the max-width, or move it outside the content. [Here's where it is in the templates](https://codeberg.org/Codeberg/Documentation/src/branch/main/content/_includes/default_layout.njk#L151). Though don't worry about this, it looks fine for now without the Table of Contents.
Sign in to join this conversation.
No Branch/Tag specified
main
renovate/major-cspell-monorepo
renovate/mstruebing-editorconfig-checker-3.x
renovate/lycheeverse-lychee-0.x
renovate/font-awesome
renovate/prettier-3.x
renovate/markdownlint-cli2-0.x
renovate/markdown-it-14.x
renovate/davidanson-markdownlint-cli2-0.x
renovate/pipelinecomponents-yamllint-0.x
renovate/11ty-eleventy-3.x
renovate/node-lts-slim
renovate/npm-pnpm-vulnerability
ci_pr_close_no_preview
pr-554
pr/554
gitea-icons-shortcode
No results found.
Labels
Clear labels
Codeberg Pages
Issues affecting Codeberg Pages
Documentation Usability
Issues related to using and reading docs.codeberg.org
Forgejo
Good First Issue! 👋
Kind: Bug
Kind: Documentation
Kind: Enhancement
Kind: Feature
Kind: Question
Kind: Security
Licensing
Part: Generator
This is related to the generation of the documentation, not to the content itself
Priority: High
The priority is high
Priority: Low
The priority is low
Priority: Medium
The priority is medium
Reviewed: Confirmed
Something has been confirmed
Reviewed: Duplicate
Something exists already
Reviewed: Invalid
Something was marked as invalid
Reviewed: Wontfix
Something won't be fixed
Status: Blocked
Status: Help wanted
Contributions are welcome!
Status: In progress
Work is in progress
Status: Needs feedback
Feedback is needed
Status: Ready for Review
Work is completed
Status: Review
Review is in progress / Reviewers wanted
Status: Stale
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Codeberg/Documentation#183
Reference in a new issue
Codeberg/Documentation
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?