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

style / layout (CSS) improvements #288

Open
justinmk opened this issue Sep 7, 2022 · 2 comments
Open

style / layout (CSS) improvements #288

justinmk opened this issue Sep 7, 2022 · 2 comments

Comments

@justinmk
Copy link
Member

justinmk commented Sep 7, 2022

How to help:

  1. make changes to gen_help_html.lua
  2. create a PR with your changes at https://github.com/neovim/neovim
  3. include a screenshot in the PR description.

Problems with layout of user docs

  • the right-side menu (table of contents) is too far away from the main content
    • DONE: remove float property and set position: fixed; left: 67%;
  • for narrow devices (mobile phone) the right-side menu should move to the top of page. currently it kinda just squishes.
  • missing header / footer from main site: https://neovim.io/

Problems with style of user docs

  • normal text is smaller than code ("preformatted") text
    • DONE: use same font-size as bootstrap <pre>
  • default font is hard / uncomfortable to read. Appears to be --serif-fonts: Lato, Cambria, Garamon, Palatino, P052, serif; from main.css.
    • Disabling that falls back to the bootstrap default, maybe that's good enough?
  • for user docs we need:
    • a <code> style that stands out while still keeping with the theme.
      • meanwhile could use the bootstrap default (which is a pinkish-red color)?
    • a color for :help tags (*foo* tags in the vimdocs) that stands out while still fitting into a normal sentence.
    • a "deemphasize" color for things like footer text
@justinmk justinmk changed the title style / css: request for improvements / help style / layout (CSS) improvements Sep 8, 2022
@justinmk
Copy link
Member Author

@dogue
Copy link

dogue commented May 29, 2024

One thing I ran into is that in the API docs, it's hard to visually pick out functions due to them being the same color as the rest of the text and nestled between the previous function's Return and their own Parameters sections, which are colored.

This makes it very easy to scroll past a function without realizing it while browsing what's available.

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

No branches or pull requests

2 participants