Documenter.jl: Feedback on new Bulma-based front end

Created on 13 Aug 2019  路  8Comments  路  Source: JuliaDocs/Documenter.jl

This is to track smaller issues with and feedback on the new front end (#1043). These would be good to fix before releasing Documenter 0.24.

The latest Julia manual build with the new front end is available here (Aug 11).

Blockers for 0.24.0:

  • [x] Margins of lists (esp. in admonitions)
  • [x] Code links
  • [x] Destaturate the link color slightly
  • [x] Subpixel antialiasing of the fonts (https://github.com/JuliaLang/julia/pull/32839#issuecomment-520935508)
  • [x] Special case code background for docstring header
  • [x] #1120

Other potential enhancements:

  • Link to point to the GitHub repo root
  • Global/local theme settings?
  • Copy to clipboard (#1055)
HTML Enhancement

Most helpful comment

One more thing: all of the code snippets now appear red, which makes it hard to differentiate which are links and which aren't:

Now:
image

Compared to:
image

All 8 comments

@mortenpi - a fantastic achievement. Thank you.

I have noticed one small thing - I am not sure if it is intended. Here are the steps to replicate it:

The effect is that "julia" also becomes dark. It seems that the theme is a global variable across tabs (at least on Chrome). I expected it to be tab-local, but maybe this is intended?

It's global for a domain, and sort of intentional (I am just using a Window.localStorage value to store the theme preference).

But it might make sense to make it local to a specific package by storing a separate value for every document root.. it might become especially relevant when people actually start deploying custom themes. OTOH, a nice feature of the current approach is that when you browse e.g. pkg.julialang.org (or any org. that hosts several packages), your theme preference will be shared by all the packages.

I agree that the approach has its merits (that is why I just wanted to make sure this is intended, as it was somewhat surprising).

Another small issue: in new theme a code without link and code with link are rendered in exactly the same way. So it is hard to know which parts of the text have links (in the old theme it was clear). Take a look e.g. at https://mortenpi.eu/gsoc2019-mockups/bulma/v13/julia/manual/strings/#. A on top is not clickable, but String in the first bullet can be clicked on. This problem is in both light and dark theme.

Nice, this looks much better, especially the new cards for the standard library methods and the syntax highlighting!

A few comments:

  1. I'm not a huge fan of the hashtags in front of the headings in the navbar.
  2. The card header seems to have some darker grey highlighting, which seems unnecessary given that the header is already all grey
  3. Some methods don't get syntax highlighting, like the second droptol! below.

Keep up the good work!

image

One more thing: all of the code snippets now appear red, which makes it hard to differentiate which are links and which aren't:

Now:
image

Compared to:
image

Hi, thanks for your work. From my perspective, here are comments:

My comments:

  1. the font in the menu bars for the current pages headers does not contrast well enough with either the light or dark themes, in my opinion.
  2. Just glancing at the above comment, I much prefer the old format for code highlighting. The red seems to pop the text too much (it鈥檚 physically much harder to read the paragraph) in addition to the link issue.

Here is my first impression: string interpolation with parentheses is unreadable with the dark theme. Other than that, love it so far!

2019-10-16-223641_548x144_scrot

Was this page helpful?
0 / 5 - 0 ratings

Related issues

galenlynch picture galenlynch  路  6Comments

thofma picture thofma  路  5Comments

lindnemi picture lindnemi  路  3Comments

carlobaldassi picture carlobaldassi  路  5Comments

mforets picture mforets  路  3Comments