v0.5.0 Beta: Server Side Rendering and Schema Components

[rohit-gohri]

Minor Changes

• 0fbefef Thanks @rohit-gohri! - Allow importing single model defenition inside mdx files - Import single model defenition inside mdx files. #46

• 12d7a26 Thanks @rohit-gohri! - Add support for SSR - Support proper Server Side Rendering #42

Patch Changes

• e0856fa #86 Thanks @rohit-gohri! - Fix common types not being exported

---

This discussion was created from the release v0.5.0 Beta: Server Side Rendering and Schema Components.

[rohit-gohri]

You will have to use the custom ServerStyle component in your Theme Root (as mentioned in facebook/docusaurus#3236 (comment)) for SSR like below:

import React from 'react';

import ServerStyle from '@theme/ServerStyle';

function Root({ children }: { children: React.Component }): JSX.Element {
  return (
    <>
	  // TODO: Remove when docusaurus adds proper css-in-js support (https://github.com/rohit-gohri/redocusaurus/issues/90)
      <ServerStyle from={children} />
      {children}
    </>
  );
}

export default Root;

See https://github.com/rohit-gohri/redocusaurus/blob/7bf52e9be23da74c1bde920377a081f5efac14a2/website/src/theme/Root/index.tsx for example project.

[aeneasr]

Awesome :)

[rohit-gohri]

FYI: This is broken in the next beta release of docusaurus AFAIK. So would recommend on staying on current dependencies for a while

[JohannesFerner]

next beta release

Beta.9 or Beta.10?
Is there currently a way to get SSR running (with ~5 different Specs in my case) running on Beta.9 ?

[rohit-gohri]

It was broken on beta.6, everything should be working on beta.9, it's tested and working with the examples: https://github.com/rohit-gohri/redocusaurus/blob/main/website/package.json.

You can read these docs on how to setup SSR

[rohit-gohri]

This is now automatically done in the upcoming redocusaurus@v1! (no need for custom @theme/Root 🙂). Along with lots of other things.

[SrMouraSilva]

Hello, @rohit-gohri. Congratulations for this awesome project.

Is there a configuration to disable SSR? I would like to the browser loads the component when a user access the page.

[rohit-gohri]

The example is live here - https://redocusaurus.vercel.app/examples/client-only/
This is the code - https://github.com/rohit-gohri/redocusaurus/blob/main/website/src/pages/examples/client-only/index.jsx

Only supported in latest v1.5.0 version of the package

[SrMouraSilva]

Thanks, @rohit-gohri. It works like a charm.
There is only a thing that isn't clear for me. How can I change redoc options? Eg. I would like to define expandResponses: "200,201",

[rohit-gohri]

I think that's part of Redocly's paid features (according to their docs - https://redocly.com/docs/api-reference-docs/configuration/functionality/#configuration-options-for-api-docs). We don't support that since we use the OSS package and so are limited to options https://github.com/Redocly/redoc/

If it's mentioned in https://github.com/Redocly/redoc/ props then we can set it otherwise probably not

[rohit-gohri]

I was wrong it should work, but still figuring out how

[rohit-gohri]

1.6.0 now loads redocly.yaml correctly for both plugin and theme so you can just define the options there