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

Add docusaurus #366

Merged
merged 5 commits into from
Jan 17, 2023
Merged

Add docusaurus #366

merged 5 commits into from
Jan 17, 2023

Conversation

baseten
Copy link
Collaborator

@baseten baseten commented Dec 30, 2022

Depends on: #364
Resolves: https://github.com/play-co/react-pixi/issues/10
Resolves: https://github.com/play-co/react-pixi/issues/11

Changes

  • Add docusaurus in separate docs package
  • Move all existing .mdx files into this package and format/edit to work with docusaurus
  • Remove eslint config as a package - it was more of a hindrance
  • Add prettier to the docs package for markdown formatting support (tried eslint-plugin-mdx but couldn't get it to work)

Notes

  • The docs package is set up to use React 18, but docusaurus doesn't support this yet as a peer dependency. This means the --legacy-peer-deps flag is required when doing an npm install. Because docusaurus hasn't been updated to support React 18 yet, it means it doesn't use the createRoot API to render anything

@baseten baseten requested a review from Zyie December 30, 2022 11:58
@baseten baseten mentioned this pull request Dec 30, 2022
Base automatically changed from convert-to-mono to master January 17, 2023 13:30
@baseten baseten merged commit 3fde56a into master Jan 17, 2023
@baseten baseten deleted the update-docs branch January 17, 2023 13: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.

None yet

2 participants