redoc

v2.2.0
ReDoc
OpenAPI OpenAPI Specification Swagger JSON-Schema API REST documentation React.js

start

webpack serve --mode=development --env playground --hot --config demo/webpack.config.ts

start:prod

webpack serve --env playground --mode=production --config demo/webpack.config.ts

start:benchmark

webpack serve --mode=production --env.bench --config demo/webpack.config.ts

test

npm run unit && npm run license-check

unit

jest --coverage

test:update-snapshot

jest --updateSnapshot

e2e

cypress run

e2e-ci

cypress run --record

bundlesize

size-limit

ts-check

tsc --noEmit --skipLibCheck

cy:open

cypress open

bundle:clean

rimraf bundles

bundle:standalone

webpack --env production --env standalone --mode=production

bundle:lib

webpack --mode=production && npm run declarations

bundle:browser

webpack --env production --env browser --mode=production

bundle

npm run bundle:clean && npm run bundle:lib && npm run bundle:browser && npm run bundle:standalone

declarations

tsc --emitDeclarationOnly -p tsconfig.lib.json && cp -R src/types typings/

stats

webpack --env production --env standalone --json --profile --mode=production > stats.json

prettier

prettier --write "src/**/*.{ts,tsx}"

changelog

conventional-changelog -p angular -i CHANGELOG.md -s -r 1

lint

eslint --fix 'src/**/*.{js,ts,tsx}' --cache

benchmark

node ./benchmark/benchmark.js

start:demo

webpack serve --hot --config demo/webpack.config.ts --mode=development

build:demo

webpack --mode=production --config demo/webpack.config.ts

publish-cdn

scripts/publish-cdn.sh

deploy:demo

aws s3 sync demo/dist s3://production-redoc-demo --acl=public-read

license-check

license-checker --production --onlyAllow 'MIT;ISC;Apache-2.0;BSD;BSD-2-Clause;BSD-3-Clause;CC-BY-4.0;CC0-1.0;Python-2.0 ' --summary

docker:build

docker build -f config/docker/Dockerfile -t redoc .

prepare

husky install

pre-commit

pretty-quick --staged && npm run lint
npm i redoc

Metadata

  • MIT
  • >=6.9
  • Roman Hotsiy
  • released 10/16/2024

Downloads

Maintainers