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

chore: added docusaurus documentation #33

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

imp-dance
Copy link

@imp-dance imp-dance commented May 10, 2023

I found the docs a bit hard to consume through github, so this is basically just a copy over from the readme to a more structured docusaurus page.

Only missing thing as far as I can tell is updating the social card and logo.svg.

Should be easier to maintain and update these docs too.

Preview:
Screenshot 2023-05-10 at 21 10 06
Screenshot 2023-05-10 at 21 10 18

The docs have been added to a subfolder, docs. You can read more about deploying with docusaurus here.

@imp-dance
Copy link
Author

Did a deploy through Netlify if you want to see a live example: https://docs--aesthetic-hummingbird-1ba96f.netlify.app/

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