9b3da59886
* implement PWA plugin * added pwa support for docusaurus website * moved sw registration to client module * moved compile function to webpack util * build sw using webpack and render pwa popup * implement @theme/PwaReloadPopup * update website sw to use modules * updated pwa readme * fix header lint errors * apply code formatting * cache files only for mobile, saveData, or installed pwa * added comments about clearing registrations * fixed prettier error * updated pwa README * fix README JS * move /blog => /blog/index.html logic to else branch * add `alwaysPrecache` option * updated docusaurus-plugin-pwa version * added pwa to using-plugins.md * review fixes * re-disable restricted-globals to use self in service worker * useless doc * Update packages/docusaurus-plugin-pwa/README.md Co-authored-by: Reece Dunham <me@rdil.rocks> * Update packages/docusaurus-plugin-pwa/README.md * update a bit pwa doc + minor refactors * minor refactors + add workbox debug mode * env PWA_ prefix * typo * minor refactor * fix file output * add serve:v2:ssl yarn command * minor pwa fixes * typo * add dynamic import comment in SW * comment * let the PWA plugin implement its reload popup on his own * pwa: add Joi options validation * pwa plugin should have its own webpack/babel custom setup * PWA: - debug logs - better SW params system - offline mode activation strategies - docs * add pwa install gif * pwa: popup -> reloadPopup + minor refactors * fix process.env reading + better debug log * minor fixes * minor changes * minor changes Co-authored-by: slorber <lorber.sebastien@gmail.com> Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com> Co-authored-by: Reece Dunham <me@rdil.rocks> |
||
|---|---|---|
| .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 | ||
| babel.config.js | ||
| CHANGELOG-2.x.md | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| crowdin.yaml | ||
| jest.config.js | ||
| lerna.json | ||
| LICENSE | ||
| LICENSE-docs | ||
| package.json | ||
| README.md | ||
| 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.