Installations
npm install @docusaurus/theme-mermaidDeveloper
Developer Guide
Module System
CommonJS, ESM
Min. Node Version
>=18.0
Typescript Support
Yes
Node Version
22.3.0
NPM Version
lerna/6.6.2/node@v22.3.0+arm64 (darwin)
Statistics
56,923 Stars
6,160 Commits
8,566 Forks
409 Watching
43 Branches
1,234 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (97.19%)
CSS (1.9%)
JavaScript (0.65%)
XSLT (0.25%)
EJS (0.02%)
Total Downloads
Cumulative downloads
Total Downloads
4,119,429
Last day
-6.5%
14,907
Compared to previous day
Last week
12.1%
86,458
Compared to previous week
Last month
9.3%
332,257
Compared to previous month
Last year
168.2%
2,987,226
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
7
Dev Dependencies
1
Docusaurus
Introduction
Docusaurus is a project for building, deploying, and maintaining open source project websites easily.
Short on time? Check out our 5-minute tutorial ⏱️!
Tip: use docusaurus.new to test Docusaurus immediately in a playground.
- Simple to Start
Docusaurus is built in a way so that it can get running in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.
- Localizable
Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.
- Customizable
While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable as well to ensure you have a site that is uniquely yours.
Installation
Use the initialization CLI to create your site:
1npm init docusaurus@latest
Read the docs for any further information.
Contributing
We've released Docusaurus because it helps us better scale and supports the many OSS projects at Meta. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.
Code of Conduct
Meta has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
Contributing guide
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.
Beginner-friendly bugs
To help you get your feet wet and get you familiar with our contribution process, we have a list of beginner-friendly bugs that might contain smaller issues to tackle first. This is a great place to get started.
Contact
We have a few channels for contact:
- Discord:
#generalfor those using Docusaurus.#contributorsfor those wanting to contribute to the Docusaurus core.
- @docusaurus X
- GitHub Issues
Contributors
This project exists thanks to all the people who contribute. [Contribute]. 
Backers
Thank you to all our backers! 🙏 Become a backer
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor
License
Docusaurus is MIT licensed.
The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.
Special thanks
BrowserStack supports us with free access for open source.
Rocket Validator helps us find HTML markup or accessibility issues.
No vulnerabilities found.
Reason
all last 30 commits are reviewed through GitHub
Reason
30 commit(s) out of 30 and 26 issue activity out of 30 found in the last 90 days -- score normalized to 10
Reason
no vulnerabilities detected
Reason
no dangerous workflow patterns detected
Reason
update tool detected
Details
- Info: Dependabot detected: .github/dependabot.yml:1
Reason
license file detected
Details
- Info: : LICENSE:1
Reason
all dependencies are pinned
Details
- Warn: npmCommand not pinned by hash: .github/workflows/tests-e2e.yml:143
- Warn: npmCommand not pinned by hash: .github/workflows/tests-e2e.yml:173
- Info: GitHub-owned GitHubActions are pinned
- Info: Third-party GitHubActions are pinned
- Info: Dockerfile dependencies are pinned
- Info: no insecure (not pinned by hash) dependency downloads found in Dockerfiles
- Info: no insecure (not pinned by hash) dependency downloads found in shell scripts
Reason
no binaries found in the repo
Reason
security policy file detected
Details
- Info: security policy detected in org repo: github.com/facebook/.github/SECURITY.md:1
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'force pushes' disabled on branch 'main'
- Info: 'allow deletion' disabled on branch 'main'
- Info: status check found to merge onto on branch 'main'
- Warn: number of required reviewers is only 0 on branch 'main'
Reason
no badge detected
Reason
non read-only tokens detected in GitHub workflows
Details
- Info: topLevel 'contents' permission set to 'read': .github/workflows/build-blog-only.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/build-blog-only.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/build-perf.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/build-perf.yml/master?enable=permissions
- Warn: jobLevel 'checks' permission set to 'write': .github/workflows/build-perf.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/build-perf.yml/master?enable=permissions
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/build-perf.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/build-perf.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/canary-release.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/canary-release.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/codeql-analysis.yml/master?enable=permissions
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/codeql-analysis.yml/master?enable=permissions
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/codeql-analysis.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/dependency-review.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/dependency-review.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/lighthouse-report.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/lighthouse-report.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/lint.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/lint.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/showcase-test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/showcase-test.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/tests-e2e.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/tests-e2e.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/tests-swizzle.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/tests-swizzle.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/tests-windows.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/tests-windows.yml/master?enable=permissions
- Info: topLevel 'contents' permission set to 'read': .github/workflows/tests.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/os33/wireguard-go/tests.yml/master?enable=permissions
Reason
project is not fuzzed
Score
7.5
/10
Last Scanned on 2022-08-15
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