Redocly/redoc

redoc-cli serve does not load assets

Open

#1264 opened on May 20, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
help wanted

Description

I would like to use redoc-cli serve while developing to see live updated to my site. However non of my images are loading. They all live in the same directory as where I call redoc. My dir structure is

/openapi
  openapi.yaml
/assets
  logo.png
template.hbs

From this directory I call: @npx redoc-cli@0.9.6 serve openapi/openapi.yaml --watch -t template.hbs Any way of making the images show up?

Contributor guide

Tech stack
typescriptnodejsreact
Domain
clidocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScriptNode.jsReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate how `redoc cli serve` handles static assets. Look at the serve command implementation in the redoc cli source (likely in packages/cli/src/commands/serve). Determine if there is a missing static file serving configuration for custom templates. Also check if the ` watch` mode has any effect on asset loading. Review any existing tests or configuration for path resolution.