* docs: improve algolia integration instructions
The current version makes it look like you need to install `@docusaurus/theme-search-algolia` on top the classic version to work, but it already works with the classic version. Adding `@docusaurus/theme-search-algolia` on top leads to errors.
* Still document installation
* Do not make separate paragraph
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
* 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>
* docs: Minor copy changes + increment numbered list
* docs: Add alternative github pages deploy workflow
* docs: Add separate PR workflow for alternative gh-pages deploy example
* docs: Minor `gh-pages` deploy config improvements
Improve some comments and clarifies the file path beyond file name alone for each config file.
Additionally removes the workflow path triggers as in practice these being updated shouldn't be triggering a re-run of the workflow again (assuming deterministic build from same input results in same output).
If there is a need for such a manual trigger of the workflow is probably a better approach. Performing a build because workflow comments were modified only would be pointless for example.
* docs: Clarify `gh-pages` deploy config some more
* chore: PR Feedback - Remove inline documentation
Upstream doesn't see value including help comments for a copy/paste config under the basis that it adds friction to the viewer seeking guidance how to perform something they don't know.
* chore: PR Feedback - Rephrase instruction
MatanBobi requested a rephrase during review.
* Rewrite
* Fixes
* Fix!
* Format
* Fix indentation
* Improvements
* Minor fixes
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
* SSH is required for GitHub deployment now
Matches what is listed in the default README.md of a new Docusaurus site
* Minimum node version required is 14.x
documentation.yml as written fails to run because the minimum node version for Docusaurus is 14.x
* Add link to default URL of locally-served site
* Correct deployment workflow
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
* feat: changed the logo properties to allow width/height specification
* fixup! feat: changed the logo properties to allow width/height specification
* fixup! feat: changed the logo properties to allow width/height specification
* Rework: add fields to logo object
* Fix
* More fixes
* Wrong width!
* No need for optional chaining
* Doc writeup
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
