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

Migrating to Docusaurus from Docsify - part 1 #51

Merged
merged 17 commits into from
Aug 18, 2024

Conversation

mshibanami
Copy link
Owner

#49

I checked Gitbook, MkDocs, and Docusaurus and decided to migrate to Docusaurus. While Gitbook and MkDocs are not bad, I believe Docusaurus is more powerful and pretty easy to maintain. Not only it has matured, but also the user base has been huge. Plus, I'm somewhat optimistic about its sustainability since Meta backs it for their projects.

I think I initially chose Docsify because I couldn't figure out how to remove Docusaurus's landing page. At least, I remember not wanting it for Redirect Web's documentation, but now that I've figured it out, it's no longer a problem.


This is part 1 of the migration, which will leave the Docsify documentation as-is for now. The new Docusaurus project and the existing Docsify project will be hosted as follows:

  • /redirect-web/: Docsify
  • /redirect-web/new/: Docusaurus

I'll also update the app later. Once the majority of the users update to that version, I'll fully replace Docsify with Docusaurus.

Copy link

netlify bot commented Aug 18, 2024

Deploy Preview for redirect-web ready!

Name Link
🔨 Latest commit b13ada9
🔍 Latest deploy log https://app.netlify.com/sites/redirect-web/deploys/66c242869136b80007de713d
😎 Deploy Preview https://deploy-preview-51--redirect-web.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mshibanami mshibanami merged commit af01913 into main Aug 18, 2024
3 of 4 checks passed
@mshibanami mshibanami deleted the new-documentation-tool branch August 19, 2024 10:56
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.

1 participant