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.

Sign up for GitHub

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

Jump to bottom

Migrate Website to Docusaurus 2 Alpha #669

Closed
Drewbi opened this issue Jun 23, 2020 · 3 comments
Closed

Migrate Website to Docusaurus 2 Alpha #669

Drewbi opened this issue Jun 23, 2020 · 3 comments

Comments

@Drewbi
Copy link

Drewbi commented Jun 23, 2020

@yangshun mentioned Litho was interested in porting the documentation website over to Docusaurus V2.

@teikjun and I are working on moving everything over currently and we will be making a PR soon.

I anticipate some alterations to the deployment config will have to be made as I'm not too experienced in that field.
@yangshun
Copy link

Relevant issue - facebook/docusaurus#1834

@teikjun teikjun mentioned this issue Jun 24, 2020
Closed
facebook-github-bot pushed a commit that referenced this issue Jul 9, 2020
@teikjun @facebook-github-bot
Migrate documentation to Docusaurus v2 (#670)
727b801 
Summary:
<!-- Thanks for submitting a pull request! We appreciate you taking the time to work on these
changes. Please provide enough information so that others can review your pull request. The three
fields below are mandatory. -->

<!-- Explain the **motivation** for making this change. What existing problem does the pull request
solve? -->

Hi there! As discussed in #669, we would like to migrate Litho's documentation website to Docusaurus 2.

Docusaurus 2 brings about many improvements:
- Client-side rendering with prerendering (site renders without JavaScript!)
- Embeddable interactive React components within markdown via MDX
- Docusaurus sites are React apps built with modern Javascript ecosystem tooling

In this PR, we've migrated the documentation over to Docusaurus 2 (in `/website` directory) while leaving the `/docs` directory intact.
We've matched the design of the original site as much as possible, so that the transition will be smooth for users of Litho.

## Changelog

<!-- Help reviewers and the release process by writing your own changelog entry. This should just be
a brief oneline we can mention in our release notes: https://github.com/facebook/litho/releases -->

Migrate documentation website from Jekyll to Docusaurus v2

Pull Request resolved: #670

Test Plan:
The test site is up! https://litho-deploy.vercel.app

Drewbi and I are looking to improve the documentation site further based on your feedback.
Please let us know what you think! :)

cc yangshun

Reviewed By: astreet

Differential Revision: D22284319

Pulled By: muraziz

fbshipit-source-id: 0ee44810b0170587979db33b964b8480de5e1d11
@colriot
Copy link
Contributor

colriot commented Mar 29, 2021

Finally all your work was deployed publicly and ready to be used with 8934eef!

Thanks again for helping us with that, @Drewbi @teikjun !

@colriot colriot closed this as completed Mar 29, 2021
@Drewbi
Copy link
Author

Drewbi commented Mar 29, 2021

Ayy thanks for the merge, hope you like the new framework :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@colriot @yangshun @Drewbi