Commit graph

57 commits

Author SHA1 Message Date
Nitya Narasimhan
a4c54aba45
docs: add Azure SWA as deployment option (#7407)
I've linked to the dev.to article (which is a timestamped stable version) - to be consistent with other deployment snippets.

The dev.to article references [this GitHub repo](https://github.com/fearlessly-dev/swa-demo-docusaurus) and  this[#30DaysOfSWA](https://www.azurestaticwebapps.dev/blog/build-with-docusaurus) site which was the inspiration for writing this article. The repo contains the code for the demo, and its README is the canonical source for the article, in case relevant.
2022-05-14 19:57:43 +08:00
Joshua Chen
5bed55aeda
refactor(types): JSDoc for docusaurus config fields (#7291) 2022-05-03 13:57:19 +08:00
Joshua Chen
ff96606865
docs: fix some casing inconsistencies (#7081) 2022-03-31 20:23:44 +08:00
Nayan Patel
1c91d2f20e
docs: fix broken links (#6817)
* Fix a broken showcase GitHub URL

* Seems like this site is no longer Open Source?

* Seems like this site is no longer open source?

* Fix as previous link leaded to a 404

* Replaces the 404 error of previous page.

Not sure if this is the correct link to be placed there.

* Fixes 404 error ;)
2022-03-03 07:02:57 +08:00
Joshua Chen
a4dc03edee
chore: upgrade dependencies (#6789)
* chore: upgrade dependencies

* upgrade setup-node
2022-03-01 10:40:34 +08:00
Ariful Alam
95ab08285b
docs: make GitHub actions explanation aligned with the code (#6776)
* fix(website): update github actions files

* revert some changes

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-02-27 16:27:23 +08:00
Joshua Chen
94532dfd26
docs: fix bad anchor link syntax (#6683) 2022-02-15 11:24:50 +08:00
Joshua Chen
a350a8a130
docs: fix bad anchor link syntax (#6611) 2022-02-05 14:52:19 +08:00
Everardo J. Barojas M
caa9d281c3
docs: improve Github Actions example jobs (#6591)
* docs: Improve docs on deploy.yml gh action

* docs: Improve docs on test-deploy.yml gh action

* docs: improve docs on delpoy.yml and test-deploy.yml gh action on next version docs

* docs: rm unneeded lines

* edits

Co-authored-by: Everardo J Barojas M <everardo@prescrypto.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-02-03 20:42:19 +08:00
Gaurish
8bdecf107c
docs: add Cloudflare pages deployment guide (#6501)
* Docs: Add Cloudflare pages deployment guide

* minor tweaks

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-29 13:27:34 +08:00
Joshua Chen
c1e3801ee7
fix(cli): allow passing a list of file names to write-heading-ids (#6500) 2022-01-29 12:21:15 +08:00
Joshua Chen
f2b1c8e80e
docs: mention how env vars can be read (#6499) 2022-01-29 11:34:30 +08:00
Nick Schonning
521eb119a7
chore: add cSpell for spell checking (#6456)
* chore: Add cSpell for spell checking

* chore: exclude map files and remove dups

* chore: exclude more binary files

* chore: remove MD headings

* Update .cspell.json

* fix a few spellings

* fix more

* fix

Signed-off-by: Joshua Chen <sidachen2003@gmail.com>

* fix a few

* oops

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-25 09:40:02 +08:00
Edouard Bonlieu
0f8bb3bbe6
docs: add Koyeb as a deployment option (#6431) 2022-01-24 18:57:02 +08:00
Joshua Chen
4872decb42
docs: normalize CodeBlock highlighting (#6223) 2021-12-30 10:51:00 +08:00
Joshua Chen
73ee356949
docs: audit grammar issues (#6203)
* docs: audit grammar mistakes

* fix code block language

* revert change

* let's get another
2021-12-27 19:34:04 +08:00
Rishi Raj Jain
6716548b87
docs: add Layer0 to deployment guide (#6188) 2021-12-25 10:17:33 +08:00
Joshua Chen
373eda272e
docs(deployment): add cost-benefit analysis with different options (#6026) 2021-12-02 18:29:13 +01:00
Rey
78537aab2a
docs: update Netlify url config option in deployment instructions (#6019)
Netlify now provides `*.netlify.app` subdomains instead of `*.netlify.com` for project sites. Redirects still work, so the current config option isn't wrong but it's a good idea to keep the docs up to date.
2021-11-27 13:34:32 +08:00
Martin Šošić
b1a4f3913d
docs: improve explanation for url config in GH Pages (#6006) 2021-11-25 16:50:34 +08:00
William Poetra Yoga
f5732e7589
feat: allow GIT_USER env var to be unset if SSH is used (#5840)
* 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>
2021-11-10 18:51:12 +08:00
Joshua Chen
13d07eff13
docs: refer to deployed branch as deployment rather than target (#5903) 2021-11-08 14:15:28 +08:00
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
Ivan Boothe
effa46e930
docs: update GitHub deployment instructions (#5888)
* 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>
2021-11-07 13:29:56 +08:00
William Poetra Yoga
ca9bd244aa
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
2021-10-31 12:29:22 +08:00
Sébastien Lorber
fc32194cbb
docs: fix lint issue (#5826) 2021-10-29 16:21:42 +02:00
Gabriel Falcão
b5b2c18118
docs: Update Drone Deployment docs (#5801) 2021-10-29 15:41:12 +02:00
Joshua Chen
d6b4eeb358
feat(theme-classic): make first tab the default tab (#5647)
* Initial work

* Little doc fix

* Doc fix
2021-10-07 17:06:17 +02:00
Joshua Chen
89cb975cc4
docs(website): document npm2yarn plugin + use new Tabs API everywhere (#5590)
* Update docs

* Bad grammar

* Add code highlight
2021-09-22 12:25:21 +02:00
Sébastien Lorber
4f59f0782e
docs: mention Netlify ignore build setting (#5486)
* mention Netlify ignore build setting

* doc backport
2021-09-03 19:34:10 +02:00
Palash Shrivastava
b665b5b859
docs: specify proper min Node.js version in Travis CI example (#5406) 2021-08-23 00:13:53 +03:00
Paul O’Shannessy
8341527fc9
refactor: rename Git master branch to main (#5345)
* Prepare to renaming master branch to main

* Update CONTRIBUTING.md

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json

* missing master -> main replaces

* useless char

* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required

* fix versioning page

* fix vercel links

* update deployment.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-17 18:41:53 +02:00
Arnaud Jeannin
2bd7f0d7a1
docs(v2): Update deploy with Qovery docs for V2 (#5158)
* Update deploy with Qovery docs for V2

Hello Docusaurus team,

I updated the docs for the new Qovery V2

https://www.qovery.com/blog/qovery-v2-beta-is-out

* run prettier on docs

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-07-14 11:26:42 +02:00
Raz Luvaton
d1f3a3631a
Open docs(v2): Indent code example to improve readability (#5152) 2021-07-13 10:09:19 +02:00
Sébastien Lorber
41eaa690ee
docs(v2): GH pages: recommend using trailingSlash (#5033) 2021-06-22 11:25:34 +02:00
Eshan Tripathi
425eccc5df
docs(v2): typo in deployment.mdx(#5030)
Corrected a minor grammatical error
2021-06-22 10:31:11 +02:00
Tomasz Papiernik
a865eb50b9
docs(v2): Add Buddy to deployment doc (#5027) 2021-06-21 18:15:01 +02:00
Teik Jun
c96c3b5c39
docs(v2): fix incorrect anchor links in website (#5021)
* docs: fix anchor links for docusaurus write-translations

* docs: fix anchor links for docusaurus serve
2021-06-20 22:16:17 +03:00
Sébastien Lorber
df8a900f9c
feat(v2): add trailingSlash config option (#4908)
* POC: add trailingSlash option

* integrate the preferFoldersOutput option of fork @slorber/static-site-generator-webpack-plugin

* Fix broken links when using trailing slash => using md links is more reliable

* fix TS issue

* minor polish

* fix doc page being sensitive to trailing slashes

* Add tests for applyTrailingSlash

* rename test files

* extract and test applyRouteTrailingSlash

* update snapshot

* add trailing slash config to serve command

* fix getSidebar() => still sensitive to trailing slash setting

* never apply trailing slash to an anchor link

* Add documentation for trailingSlash setting
2021-06-09 19:59:39 +02:00
Fardeen Panjwani
62caaeddbb
docs(v2): update steps in the github-actions section (#4876)
* docs: update steps in the github-actions section

* refactor: format warning

* Update website/docs/deployment.mdx

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2021-06-01 18:05:26 +02:00
Arnaud Jeannin
66254cf0b3
docs(v2): Add Qovery to deployment doc (#4496)
* Support Qovery as a deployment option

* chore: Add .qovery.yml file to deploy app with Qovery 🚀

* refacto: rm backported doc and yaml

* refacto: rm backported docs

* revert file deletion

* prettier

Co-authored-by: Qovery <support@qovery.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-04-27 11:06:08 +02:00
Luis Medina Huerta
2f34f9d4bd
docs(v2): Fix urls in deployment.md (#4680)
* docs: update links in deployment.mdx

* fix type in link

* update links to inlineblock

Co-authored-by: luism3861 <eduardo_media@fragua.com.mx>
2021-04-27 10:11:30 +02:00
alena-ko
ad74342a14
docs(v2): Add Hostman to deployment doc (#4668)
* Update deployment.mdx

* prettier + doc fixes

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-04-26 20:22:47 +02:00
Tales Porto
e99bb43823
feat(v2): docusaurus deploy: ability to configure port in git url (#4545)
* Creating a way to configure the port used on the guthub deploy.

* Fixing some mistakes

Documenting

Adding githubPort documentation on docusaurus.config.js.

Addind SSH protocol prefix. ssh://

Using the default protocol port instead of define it on the code.

Prettify.

* Fixing some mistakes

Documenting

Adding githubPort documentation on docusaurus.config.js.

Addind SSH protocol prefix. ssh://

Using the default protocol port instead of define it on the code.

Prettify.

* Isolating the logic to generate the url and testing it.

* Changing all the names used on tests to something more unserstandable.

* Prettify

Co-authored-by: Tales Porto <t.andrade-porto@klarna.com>
2021-04-09 18:05:16 +02:00
Forresst
51a7988923
docs(v2): fix typo deployment.mdx (#4539) 2021-03-31 15:51:13 +02:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Reece Dunham
76c0b11632
refactor(v2): TS config update: reduce the size of npm modules (#4375)
* feat(v2): Reduce the size of the npm modules

Signed-off-by: Reece Dunham <me@rdil.rocks>

* Fix conflicts

* Update search.js

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-17 16:25:42 +01:00
Steve
66e621dca9
docs(v2): add Deploy with QuandCDN (#4430)
* Update deployment.mdx

- Adds QuantCDN deployment target.

* Update deployment.mdx

* Update website/docs/deployment.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

* Add QuantCDN docs to showcase.

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-03-16 19:25:12 +01:00
Sébastien Lorber
6811a72e72
feat(v2): ability to "escape" JSX in MDX files as code blocks (#4278)
* Fix MDX Crowdin issues by wrapping complex JSX in code blocks

* Add a remark plugin to unwrap MDX code blocks

* Update MDX Crowdin doc
2021-02-24 12:34:03 +01:00
Matan Borenkraout
967386f4e1
docs(v2): remove npx and use github action to configure ssh key (#4263)
* docs(deployment): remove npx and fix github email

* refactor: use ssh configure action instead of own implementation
2021-02-22 16:21:18 +01:00