Skip to content

Add Docusaurus site with current documentation and blog #59

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

Merged
merged 12 commits into from
Nov 10, 2021

Conversation

dondonz
Copy link
Member

@dondonz dondonz commented Nov 8, 2021

Major renovation to the site, whilst maintaining all content and preserving existing URLs. See this fork live: https://priceless-haibt-31ae6b.netlify.app

Docusaurus is an easy-to-use docs generator, just add Markdown. It gives you all the nice features of React without requiring any knowledge of React nor JS. There's hot reloading, linter to check for dead links, awesome search support and sensible CSS defaults.

Docusaurus is actively maintained by Facebook https://docusaurus.io/. If you've used React, Relay, or React Native documentation lately, you've already seen Docusaurus in action.

Here's what's in this PR so far

  • Next (master), current (v17), and previous (v16) documentation fully migrated. I went through and tidied up all the code formatting. Defaults to v17
  • All blog posts migrated, with the same URLs
  • About page migrated
  • Fancy frontend renovations - colour scheme, better header and footer, edit buttons everywhere to encourage contributions
  • Tutorial on separate tab

After initial ship

  • Option to add more text on the landing page later
  • Awaiting Algolia's reply on DocSearch, a daily automated crawler. Will add search after we receive our API key

@dondonz dondonz merged commit 797a790 into graphql-java:master Nov 10, 2021
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