docusaurus/website/docs
Brennan Kinney caa9d923a6
docs: add example for Github Pages deployment; rewrite deployment section (#4409)
* 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>
2021-11-07 16:29:08 +08:00
..
_partials feat(v2): generalize usage of _ prefix convention to exclude content files/folders (#5173) 2021-07-15 13:21:41 +02:00
api feat(theme-classic): allow specifying width/height in logo (#5770) 2021-11-01 18:09:30 +08:00
assets chore: fix Crowdin again (#5825) 2021-10-29 15:37:45 +02:00
guides docs: Fix a typo in versioning.md (#5852) 2021-11-02 14:23:06 +08:00
i18n docs: use "npx create-docusaurus" for init (#5797) 2021-10-27 14:46:25 +02:00
migration docs: add h4 into toc on certain pages (#5728) 2021-10-19 20:15:11 +02:00
blog.mdx feat(content-blog): new readingTime plugin option (#5702) 2021-10-21 15:26:10 +02:00
browser-support.md docs(v2): add browsers support documentation (#4758) 2021-05-11 11:03:05 +02:00
cli.md feat(core): write-heading-ids options maintainCasing, overwrite (#5740) 2021-10-21 12:33:52 +02:00
configuration.md feat: allow user to specify deploymentBranch property in docusaurus.config.js (#5841) 2021-10-31 12:29:22 +08:00
deployment.mdx docs: add example for Github Pages deployment; rewrite deployment section (#4409) 2021-11-07 16:29:08 +08:00
docusaurus-core.md docs: fix wrong code sample in docusaurus-core (#5881) 2021-11-05 22:57:59 +08:00
installation.md chore: require Node 14 (#5812) 2021-10-28 17:11:25 +02:00
introduction.md docs: '5 minutes tutorial' -> '5-minute tutorial' (#5876) 2021-11-05 10:58:57 +08:00
lifecycle-apis.md docs: add h4 into toc on certain pages (#5728) 2021-10-19 20:15:11 +02:00
playground.mdx feat: docusaurus.new + improved StackBlitz playground (#5235) 2021-07-28 19:27:58 +02:00
presets.md feat(preset-classic): guard against unknown keys in options (#5831) 2021-10-30 12:39:12 +08:00
search.md docs: remove duplicated appId property (#5869) 2021-11-04 13:51:01 +08:00
seo.md docs: create SEO documentation page (#5759) 2021-11-04 12:57:27 +01:00
static-assets.md docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
styling-layout.md docs: update docusaurus-plugin-sass instructions (#5352) 2021-08-13 12:47:13 +02:00
typescript-support.md docs: use "npx create-docusaurus" for init (#5797) 2021-10-27 14:46:25 +02:00
using-plugins.md docs(v2): Fix typo in using-plugins.md (#5750) 2021-10-20 15:38:25 +02:00
using-themes.md docs: fix a typo in using-themes.md (#5868) 2021-11-04 12:40:36 +08:00