Upgrade project documentation website to Docusaurus v2
Closed this issue · 3 comments
Background
Bemuse project website is still using Docusaurus v1 which is no longer maintained.
Task
- Upgrade the site from Docusaurus v1 to Docusaurus v2.
- It is expected that a Docusaurus v2 site will look different from Docusaurus v1.
- Please use the classic template with TypeScript.
- Please disable the Blog functionality.
- Please keep the color scheme.
- Please make sure every page is working and all contents are intact.
- Home page
- Docs page and all pages within.
- Artists showcase
- Contributors page
- There are some Vue code to make some parts of the documentation interactive. Examples: Colors page and Artists showcase. Please convert them into MDX.
- Please include a screenshot in your PR to confirm that it is working.
Hacktoberfest
If you would like to work on this task, please write a comment stating your intent. We will then assign the issue to you. To ensure continuity, the issue will be unassigned after 3 days of inactivity — so please keep us updated.
Getting assigned to an issue is NOT a reservation. It is simply to let others know that someone is already working on it to avoid duplicated efforts. The first person who submits a valid Pull Request (PR) that resolves the issue will have their PR merged, regardless of who was assigned to the issue. However, if you are assigned to an issue and start working on it, but someone else submits a valid PR before you, you can still submit a valid PR even if it has conflicts. The PR will be given the "hacktoberfest-accepted" label and the issue will be closed.
If you encounter any problem, please include relevant logs and screenshot so it’s easy to troubleshoot.
I'm working on this now.
@dtinth I tried to migrate website, but it has been required appId
of Algolia to build the site. Can you give me the id, please?
@MikuroXina Thanks, here you go:
appId: 1I7X31Q06Y
apiKey: ec8ae66306d3f7049a8be3b5a6216ce8
indexName: bemuse