mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-05 13:17:23 +02:00
f5732e7589
* feat: allow GIT_USER env var to be unset if SSH is used * fix: packages/docusaurus/src/commands/deploy.ts Co-authored-by: Joshua Chen <sidachen2003@gmail.com> * feat: allow user to specify deploymentBranch property in docusaurus.config.js (#5841) * feat: allow user to specify deploymentBranch property in docusaurus.config.js * docs: remove extra backtick * docs: fix broken code block * docs: fix i18n routes to feature requests (#5843) * docs: fix i18n routes to feature requests * Add redirect rules * feat: allow GIT_USER env var to be unset if SSH is used * fix: packages/docusaurus/src/commands/deploy.ts Co-authored-by: Joshua Chen <sidachen2003@gmail.com> * fix: avoid escaping hyphen in regex * Refactor * Update deployment.mdx * Make SSH higher priority * Only infer but not override * Add tests * Fix tests * Fix Co-authored-by: Joshua Chen <sidachen2003@gmail.com> |
||
|---|---|---|
| .. | ||
| bin | ||
| src | ||
| templates | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
create-docusaurus
Create Docusaurus apps easily with simplified commands:
npm init docusaurus
yarn create docusaurus
Usage
Please see the installation documentation.
For maintainers
For Docusaurus maintainers, templates can be tested with:
cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website
yarn create-docusaurus test-website classic
cd test-website
yarn start
Note: test-website is not part of the workspace and use packages from npm.
Use the following to test the templates against local packages:
cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website-in-workspace
yarn create-docusaurus test-website-in-workspace classic
cd test-website-in-workspace
yarn start