Migrate Website to Docusaurus 2 Alpha

[mishal23]

Hi there! The Docusaurus team is currently developing Docusaurus 2 and are almost done with an MVP that doesn't include translations and versioning features, which means there's feature parity with your website's current usage of Docusaurus.

Docusaurus 2 brings about many improvements:

• Client-side rendering with prerendering (site renders without JavaScript!)
• More flexible appearance - Customizable layouts, CSS modules, etc
• Embeddable interactive React components within markdown via MDX

I will be helping you migrate and be the POC throughout the migration process. Let me know what you think!

cc @yangshun @endiliey @wgao19

[jvillard]

I am confused: the infer documentation does not use Docusaurus at the moment.

[yangshun]

Hey @jvillard sorry, that was a template statement. In Infer's case, it will be a migration from the current static site generator (Jekyll?) to Docusaurus 2, skipping Docusaurus 1 entirely.

[jvillard]

Nice! Let us know if you need anything from our side.

[smorimoto]

Can I take this?

[smorimoto]

Almost done!

[smorimoto]

Preview here! https://build-9j1y8wnmo.now.sh

[smorimoto]

Some content on the top page has been deleted, but I will add it if necessary. and Should I target the master branch when I submit PR? Or would you like to continue targeting the gh-pages branch?

[smorimoto]

https://github.com/imbsky/infer/tree/docusaurus

[yangshun]

I'd leave that to the @jvillard to decide. Typically for D2 websites, the gh-pages branch should be for the build artifacts and the website code will be in a website directory within master branch.

@mishal23 just FYI that @imbsky has started work on it. @imbsky in future it'd be better to get green light from @mishal23 before taking over the task.

[smorimoto]

Typically for D2 websites, the gh-pages branch should be for the build artifacts and the website code will be in a website directory within master branch.

I will open PR to the master branch.

@imbsky in future it'd be better to get green light from @mishal23 before taking over the task.

Definitely!

[smorimoto]

I decided to use @uetchy's Math API instead of Katex. That's very good.

[smorimoto]

[jvillard]

Having the website source on the master branch will be a lot more convenient, thanks!

[smorimoto]

Anytime. I love Infer and am happy to contribute to it even though it's not main Infer code!

[yangshun]

Thank you @imbsky!

[smorimoto]

I'm adding some original top page content now, but it's strictly different from Jekyll, so it may look a little different.

[smorimoto]

It takes a lot of additional code to fully reproduce an asciinema embed. It should be avoided considering maintainability. For example, it can become a liability the next time we upgrade to Docusaurus 3.

[smorimoto]

For that reason, We can't auto play it at the moment, is that okay?

[yangshun]

@imbsky make a PR and we can review it. There should be ways to let ASCII cinema still autoplay.

See https://github.com/facebookresearch/hydra/blob/master/website/docs/tutorial/7_tab_completion.md for an example of embedding in the D2 approach. You should just need to set data-autoplay="true" for the added script tag.

[smorimoto]

Autoplay still doesn't work...

[smorimoto]

But it's great because it doesn't open in a new tab.

[smorimoto]

Latest preview here! https://build-8sx47qcn4.now.sh

[smorimoto]

The mobile view in the "Who Uses Infer?" section has also been slightly improved!

[yangshun]

I must say, it looks gorgeous :)

On Fri, Nov 22, 2019 at 2:55 PM BSKY notifications@github.com wrote:

The mobile view in the "Who Uses Infer?" section has also been slightly improved!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/facebook/infer/issues/1171?email_source=notifications&email_token=AAKBCHIMTKZ76EPMDCRRNATQVBPORA5CNFSM4JFWWQ22YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEE7DGQA#issuecomment-557724480, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAKBCHJKARWE5HCXJU5VAL3QVBPORANCNFSM4JFWWQ2Q .

[smorimoto]

@jvillard We can install Infer via brew core even if we on Catalina (and Mojave), would you like to fix the install guide to avoid confusion?

[smorimoto]

I increased the font size because the font size in the code block was too small to see.

[smorimoto]

Before	After

[jvillard]

Docusaurus 2 website is up now, closing. :heart_eyes: