Redocly / Redocly/create-openapi-repo
Deploy on Github Pages a full rendered HTML of ReDoc
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 695
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
I would publish a full rendered HTML of Redoc on Github Pages.
When I build it is generated only the yaml documentation, no HTML is built
npm run build
test@1.0.0 build /Users/giovanni.marino/Docs/test
openapi bundle -o distCreated a bundle for openapi/openapi.yaml at dist/openapi.yaml
no web_deploy folder is created, only dist folder with just yaml file
to push dist folder on github pages I set gh-pages as #8
Yaml file is deployed correctly but as I said I need to push the entire redoc html
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the npm run build command and its openapi bundle -o dist step, then inspect how the repository handles the dist and web_deploy folders. Reproduce the build and check the gh-pages deployment setup. Done means the build produces the rendered ReDoc HTML alongside the YAML and that the full HTML is published on GitHub Pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, javascript, openapi
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100