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

feat!: migrate to vitepress #1

Merged
merged 2 commits into from
Nov 15, 2023
Merged

feat!: migrate to vitepress #1

merged 2 commits into from
Nov 15, 2023

Conversation

NozomuIkuta
Copy link
Collaborator

This PR is created based on conversation on Twitter.
cc: @ubugeeei

With this proof of concept (although I migrated almost everything already), you can preview VitePress' look-and-feel and developer experience.

  1. Update dependencies

    pnpm install
  2. Run dev server

    pnpm run dev
  3. Build the website

    pnpm run build

Here are some information about VitePress and developer experience:

  • Obviously, VitePress uses Vue, while Docusaurus uses React
  • Almost all features can be migrated except Docusaurus' blog feature
    • We have to make up post list page as needed, which is not included in this PR yet
    • We have to calculate reading time as needed, which is not included in this PR yet
    • We have to add post titles to .vitepress/config.ts manually for them to be shown in sidebar (we might be able to do some automation)
  • I added 2 custom components to make up missing design (see .vitepress/theme/components directory)
  • We have to set up Prettier for .vue files (not included in this PR yet)
  • We have to set up some lint for CSS in .vue files (browserslist is temporarily deleted in this PR for simplicity)

VitePress has some features that you might get interested in:

@Boshen
Copy link
Member

Boshen commented Nov 12, 2023

Thank you for working on this! I made a vote since we have 2 PRs https://twitter.com/boshen_c/status/1723535140343931205

@Boshen
Copy link
Member

Boshen commented Nov 13, 2023

We can start merging once CI passes.

@NozomuIkuta
Copy link
Collaborator Author

@Boshen

Would you run CI again?

@Boshen Boshen marked this pull request as ready for review November 15, 2023 00:49
@Boshen Boshen merged commit 0aeb28b into oxc-project:main Nov 15, 2023
1 check passed
@NozomuIkuta NozomuIkuta deleted the feat/migrate-to-vitepress branch November 15, 2023 00:54
@NozomuIkuta
Copy link
Collaborator Author

NozomuIkuta commented Nov 15, 2023

@Boshen

Thank you for merging!

From now on, I will add some missing features and improve developer experience 🙋‍♂️
Additionally, if you want, we could discuss information architecture including oxc-project/javascript-parser-in-rust#19, as another issue.

@Boshen
Copy link
Member

Boshen commented Nov 15, 2023

@Boshen

Thank you for merging!

From now on, I will add some missing features and improve developer experience 🙋‍♂️ Additionally, if you want, we could discuss information architecture including oxc-project/javascript-parser-in-rust#19, as another issue.

Thank you for all the help!

@Boshen Boshen mentioned this pull request Nov 15, 2023
4 tasks
@Boshen
Copy link
Member

Boshen commented Nov 15, 2023

@NozomuIkuta I gave you write access to this repo https://github.com/oxc-project/oxc-project.github.io/invitations

I'm going to dump content as time goes on. You are free to adjust things as you fit, no permission required.

@NozomuIkuta
Copy link
Collaborator Author

@Boshen

Thank you so much!!
I'm honored to be given such a great opportunity.

Although I'm not yet familiar with Rust enough to contribute to the core, I will do my best so that Oxc will be recognized and used by more people in the community.

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