Gathering detailed insights and metrics for redocusaurus
Gathering detailed insights and metrics for redocusaurus
Installations
npm install redocusaurusDeveloper
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
>=14
Typescript Support
Yes
Node Version
18.17.1
NPM Version
9.6.7
Statistics
647 Stars
492 Commits
113 Forks
9 Watching
13 Branches
39 Contributors
Updated on 27 Nov 2024
Languages
TypeScript (63.3%)
CSS (16.66%)
JavaScript (12.29%)
MDX (4.34%)
Shell (3.41%)
Total Downloads
Cumulative downloads
Total Downloads
1,542,949
Last day
-5.4%
3,598
Compared to previous day
Last week
9.4%
19,802
Compared to previous week
Last month
7.1%
80,540
Compared to previous month
Last year
77.8%
824,544
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Peer Dependencies
2
Versions
Redocusaurus
Redoc for Docusaurus.
Usage
Check the documentation on the website
Demo
See Examples
Packages
Redocusaurus
A Docusaurus Preset that combines the below 2 packages to easily add API doc(s) to your docs site.
Docusaurus Theme Redoc
A wrapper around RedocStandalone to make it match the Docusaurus Theme with added support for Dark Mode.
Docusaurus Plugin Redoc
A content plugin that creates pages from your OpenAPI files or URLs and renders them using the Redoc component from the theme.
Website
Docs website and example project show casing the preset in action with multiple different OpenAPI specs.
Who is using Redocusaurus?
See Who is using Redocusaurus? section in docs.
Contributing
Any help is greatly appreciated, check the DEVELOPMENT.md for help on how to setup the project in your local and CONTRIBUTING.md for general info about the contribution workflow.
Motivation
To have the documentation and API reference in the same site with the same headers/footers. Read more in the blog post, OpenAPI for Docusaurus.
See this issue, https://github.com/facebook/docusaurus/issues/638, and this gist, https://gist.github.com/rohit-gohri/b1a19f37702cfe4a6c5a47933a11785b for more details and history.
License
No vulnerabilities found.
Reason
13 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 6/11 approved changesets -- score normalized to 5
Reason
6 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: topLevel 'contents' permission set to 'read': .github/workflows/build.yml:11
- Warn: no topLevel permission defined: .github/workflows/e2e.yml:1
- Warn: no topLevel permission defined: .github/workflows/version.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/build.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:104: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/build.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/e2e.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/e2e.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/e2e.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/e2e.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/version.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/version.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/version.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/version.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/version.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/version.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/version.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/rohit-gohri/redocusaurus/version.yml/main?enable=pin
- Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 4 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 26 are checked with a SAST tool
Score
4.3
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More