Skip to content

Revisit text-formatting styles #80

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

Closed
mejedi opened this issue Oct 7, 2016 · 0 comments
Closed

Revisit text-formatting styles #80

mejedi opened this issue Oct 7, 2016 · 0 comments
Assignees
Labels
design [nature] Design issue site [area] Task relates to Tarantool's website

Comments

@mejedi
Copy link
Contributor

mejedi commented Oct 7, 2016

Text styling in docs generally doesn't look great.

Styles must use em units, enabling sharing the greater part of the stylesheet between desktop and mobile and scaling everything proportionally (#79).

Currently open issues labeled design

Basics

  • line spacing is too small; line-height: 1.4 looks better
  • normal text is too light, emphasised (bold) text stands out too much
  • section headers don't stand out enough
  • move to text-decoration: none links (no underline)

Vertical spacing between blocks

Vertical spacing is an important tool, separating different blocks of information while retaining visual consistency.

  • vertical spacing before section header should noticeably exceed a regular inter-paragraph gap
  • vertical spacing before and after bullet list and enumeration, as well as the gap between list items, should be consistent with an inter-paragraph gap
  • vertical spacing around embedded table or a block of code should be consistent with an inter-paragraph gap as well
  • sometimes the spacing just gets odd
  • spacing around note/error [scroll up after following the link] blocks is too small, especially if a section header follows

Horizontal indentation

  • horizontal indentation in bullet lists and enumerations is wrong — the bullet must move further to the right; currently it is in line with the left text margin
  • function description bodies should be indented further to the right (see how Python docs do it)

Misc

* tables often need more breathing air

@mejedi mejedi added design [nature] Design issue site [area] Task relates to Tarantool's website labels Oct 7, 2016
@lenkis lenkis closed this as completed Jun 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design [nature] Design issue site [area] Task relates to Tarantool's website
Projects
None yet
Development

No branches or pull requests

3 participants