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

Update Docusaurus to 1.3.1 #398

Merged
merged 2 commits into from
Jul 1, 2018
Merged

Update Docusaurus to 1.3.1 #398

merged 2 commits into from
Jul 1, 2018

Conversation

yangshun
Copy link
Contributor

@yangshun yangshun commented Jun 24, 2018

Summary

Docusaurus 1.3.1 brings about some backwards-incompatible CSS changes. So the team is helping the major users update 😄

I removed some custom CSS pertaining to the side nav as the fixed nav is now part of Docusaurus core. Also changed the code blocks in table markup and standardized them across the site.

cc @JoelMarcey @endiliey

Test plan

Ran the site locally and visited every page.

screen shot 2018-06-23 at 10 22 21 pm
screen shot 2018-06-23 at 10 22 28 pm

@chenglou
Copy link
Member

chenglou commented Jun 28, 2018

That's some kind of open source support... thank you so much!

  • I've noticed that the cut off point for shrinking into a navigation-at-the-top view is now 1024px. However, the Edit button for each page still stays until 736px. Is this intentional? Also, the page header's cut off point is still 736px.
  • The Edit button isn't vertically centered relative to the title, and has extra margin to the right (misaligned vs the content area and the button at the bottom for navigating to the next page):
    screen shot 2018-06-28 at 12 46 15 am
  • Search style broke on small view:

screen shot 2018-06-28 at 12 47 54 am

- We have our custom code style where the code border horizontally extends beyond the content area. The new cut-off point of 1024px makes the code block look a bit weird from 736px to 1024px. This is our own hack; we'll fix it. - Table view indeed looks much nicer now =D - You fixed the blockquote first paragraph's padding! Thanks - Headers are now black and bold; is this intentional? I'm fine either way

Thanks again for doing all of this...

@yangshun
Copy link
Contributor Author

I've noticed that the cut off point for shrinking into a navigation-at-the-top view is now 1024px. However, the Edit button for each page still stays until 736px. Is this intentional?

Not really, thanks for pointing it out.

Also, the page header's cut off point is still 736px.

The Edit button isn't vertically centered relative to the title, and has extra margin to the right (misaligned vs the content area and the button at the bottom for navigating to the next page):

Will fix that!

Search style broke on small view:

Will fix that!

We have our custom code style where the code border horizontally extends beyond the content area. The new cut-off point of 1024px makes the code block look a bit weird from 736px to 1024px. This is our own hack; we'll fix it.

Got it. I think with the new styling the code border looks better without extending beyond the content.

Table view indeed looks much nicer now =D

Yay!

You fixed the blockquote first paragraph's padding! Thanks

That has been annoying me for a while. Glad that it's fixed now.

Headers are now black and bold; is this intentional?

Yep I think it's more professional for documentation websites to have black headings. I referenced a ton of existing documentation sites and they all have neutral color headings. Users could easily override this if they wanted, so feel free 😄

I'll address the above-mentioned CSS issues in Docusaurus and we'll release a 1.3.1 and I'll update this PR with 1.3.1. Thanks for the thorough review!

@yangshun yangshun changed the title Update Docusaurus to 1.3.0 Update Docusaurus to 1.3.1 Jun 30, 2018
@yangshun
Copy link
Contributor Author

yangshun commented Jun 30, 2018

Ok we released Docusaurus 1.3.1 and I updated this PR with that Docusaurus version!

@chenglou
Copy link
Member

chenglou commented Jul 1, 2018

Thanks so much =)
Merged and filed an extra PR at facebook/docusaurus#817

@chenglou chenglou merged commit 341376e into reasonml:source Jul 1, 2018
@yangshun yangshun deleted the docu branch July 1, 2018 02:40
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

Successfully merging this pull request may close these issues.

2 participants