Redocly / Redocly/redoc

Browser side rendering

Open
#1,739 13 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the bug
I followed the "quick start" guide and am attempting to load a spec in the browser and getting a "path.join is not a function". Is only server-side rendering supported? I didn't see anything to that effect in the quickstart guide.

Expected behavior
To be able to use the RedocStandalone in an existing react application

I might be missing something, but from the docs it seems that all I need are the packages installed, and then can use the RedocStandalone react component to render the docs in the browser without utilizing the server side redering abilites. If this is not correct, what am I missing?


import { RedocStandalone } from 'redoc';

export const ApiSpec = (definition: any) => (
  <RedocStandalone
    spec={definition}
    options={{
      theme: { colors: { primary: { main: '#dd5522' } } },
    }}
  />
);

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the quick-start setup with RedocStandalone in an existing React application and trace the reported "path.join is not a function" error. Review the 13-comment discussion for the intended outcome; done should be either browser rendering working or the quick-start documentation clearly stating the supported rendering mode.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.