Refactor docs generator HTML scaffold #5816
Conversation
This dries up sidebar code. Element IDs for CSS selectors are replaced with classes to reduce specificity in stylesheets (avoid specificity wars). Flexbox is better than absolute positioning as it allows for more flexible layout and dimensions.
|
Sidebar got bit (too) wide after this change. Also, now it "jumps" after page change (Chrome 65 on OS X) - to reproduce go to https://crystal-lang.org/api/master/, type search for some sth and hit enter, then on site refresh you'll see that sidebar goes expands in width and goes back to previous state after full site load. |
|
@Sija Hm, yeah that's because the width of the sidebar is influenced by the width of the main body and it adjust after that one is loaded/rendered. You can simulate this by toggling Now that this PR is merged, I plan to continue with a layout overhaul to make it adaptive for smaller screen sizes. This will be fixed then. I don't think it is worth a hot-fix. |
| left: 0; | ||
| width: 20%; | ||
| .sidebar { | ||
| width: 30em; |
There was a problem hiding this comment.
This is unacceptable on vertical monitors. I think it's worth a hot fix because it's simple to use the old 20% value.
There was a problem hiding this comment.
What exactly is unacceptable?
There was a problem hiding this comment.
That it takes up more than a third of my monitor.
There was a problem hiding this comment.
Which browser and resolution?
There was a problem hiding this comment.
firefox, 1200x1920, custom base font size of 20px instead of 16px because idiots designers with their hidpi macbooks chronically make web fonts too small.
There was a problem hiding this comment.
True, on my MBA screen (1440×900) looks unnaturally wide too... :(
|
Do you think is a good idea to leave a downloadable version of the docs if the commit message matches |
|
@bcardiff why not every PR? We builds the docs in all CI runs anyway (iirc) |
|
@RX14 I didn't want to store unnecessary artifacts. It seems that the quota is per file size and not per repo in circle... https://circleci.com/docs/2.0/artifacts/
|
|
I don't think having it downloadable is worth it. You can easily checkout the branch and run |
This PR restructures some of the HTML templates for generating API docs. This is a piece extracted from #4755.
<head>tag to_head.htmlpartial_sidebar.htmlpartialThese are all just structural changes without changing any visuals. The only exception is that the sidebar now is always
30 emwide instead of20%of screen size (which could get pretty tight on small screens).