0f59cd1599
* feat(v2): add option validation lifecycle method * chore(v2): add dependencies * chore(v2): add yup dependency * feat(v2): add option validation for plugin-content-docs * chore(v2): add facebook copyright * refactor(v2): remove unused variable * chore(v2): add dependencies * chore(v2): add copyright * fix(v2): use strict for option validation * feat(v2): add option validation for plugin-content-pages * feat(v2): add schema for plugin-google-analytics and plugin-google-gtag * feat(v2): add option validation for plugin-sitemap * chore(v2): add dependency for yup * fix(v2): remove strict to allow normalization * refactor(v2): refactor validate method * feat(v2): modify existing tests * feat(v2): add tests for plugin normalization * style(v2): use a more descriptive filename for schema * feat(v2): add normalization tests * feat(v2): add more tests for option validation * refactor(v2): remove unused code * refactor(v2): remove unused code * refactor(v2): refactor methods and types * feat(v2): replace Yup with Joi * fix(v2): fix plugin-content-docs schema * feat(v2): modify tests for plugin-content-docs * fix(v2): fix a typo * refactor(v2): improve tests and refactor code * feat(v2): support both commonjs and ES modules * refactor(v2): refactor validateOption method * style(v2): fix eslint errors and typo in types * chore(v2): remove unused yup dependency * style(v2): standardize naming across official plugins * chore(v2): update test snapshots * chore(v2): remove obsolete snapshots * chore(v2): fix a typo and check test * feat(v2): add validation for new field * feat(v2): add test for new field |
||
|---|---|---|
| .circleci | ||
| .github | ||
| .runme | ||
| admin | ||
| docs | ||
| jest | ||
| packages | ||
| website | ||
| website-1.x | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .gitpod.yml | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| .stylelintrc.js | ||
| .watchmanconfig | ||
| CHANGELOG-2.x.md | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| LICENSE-docs | ||
| README.md | ||
| babel.config.js | ||
| crowdin.yaml | ||
| jest.config.js | ||
| lerna.json | ||
| package.json | ||
| tsconfig.json | ||
| yarn.lock | ||
Docusaurus
We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the Docusaurus v2 website for more details.
You can see the clean live demo with classic theme by clicking this badge
.
Introduction
Docusaurus is a project for easily building, deploying, and maintaining open source project websites.
- Simple to Start Docusaurus is built to be easy to get up and running in as little time 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
Docusaurus is available as the docusaurus package on npm.
We have also released the docusaurus-init package to make getting started with Docusaurus even easier.
Contributing
We've released Docusaurus because it helps us better scale and supports the many OSS projects at Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.
Code of Conduct
Facebook 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 with two text channels:
#docusaurus-usersfor those using Docusaurus.#docusaurus-devfor those wanting to contribute to the Docusaurus core.
- @docusaurus on Twitter
- 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.