Commit Graph

667 Commits

Author SHA1 Message Date
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
Can Olcer 8359ff36cd
docs: improve algolia integration instructions (#6008)
* 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>
2021-11-25 20:03: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
Alexey Pyltsyn 3551212d50
docs: update links to default translations dir (#5979) 2021-11-20 18:44:28 +01:00
Alexey Pyltsyn 63bd6b9025
refactor: define own translations in other themes (#5849)
Co-authored-by: Armano <armano2@users.noreply.github.com>
2021-11-20 16:35:27 +01:00
Oliver Ullman 1366c31201
feat(core): allow sourcing from multiple static directories (#4095)
* [WIP] Implementaion of multiple directory static sourcing

* Move default to validation

* Update test

* Refactor

* Port to MDX loader

* Fix

* Move dogfooding assets

* Doc writeup

* Restore assets

* Support absolute paths

* Dogfood absolute path

* Fix

* More tests

* Fix snapshots

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-18 22:26:26 +08:00
Morooka Kotaro 284cdabb0a
docs: fix BrowserOnly return statement (#5953)
* docs: fix BrowserOnly return statement

* Update docusaurus-core.md

* Fix version docs

* prettier

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-15 21:27:45 +08:00
Afshin Mehrabani 54d0755493
feat(create-docusaurus): allow using local folder as template (#3458)
* feat(docusaurus-init): search the local ./templates folder during doc init

* Add docs

Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-15 12:37:22 +08:00
Joshua Chen ac88d979f1
refactor(ganalytics, gtag): move options out of themeConfig (#5832)
* refactor(ganalytics, gtag): move options out of themeConfig

* Forbid themeConfig options

* Add PR link

* Add key names to error message

* Fix?

* Doc updates

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-11-10 19:04:43 +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 ecce576bbc
docs: new APITable comp to render large tables (#5891) 2021-11-10 11:38:23 +01:00
Joshua Chen 4478dd9659
docs: make API sidebar partially autogenerated (#5917)
* docs: make API sidebar autogenerated

* fix paths
2021-11-10 14:08:50 +08:00
Swalah Amani c541e2d83c
misc: replace all "Metadatas" with "Metadata" (#5871)
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-09 19:46:10 +01:00
Devtato 1c024470e0
feat(content-blog): allow sorting posts in ascending order (#5787) 2021-11-09 18:25:43 +01:00
Joshua Chen 13d07eff13
docs: refer to deployed branch as deployment rather than target (#5903) 2021-11-08 14:15:28 +08:00
Joshua Chen 0fc7adfba9
docs: document global variables in MDX scope (#5900)
* Adding a note for how to access frontMatter within pages

* Move documentation

Co-authored-by: cd rubin <github@earthling.za.net>
2021-11-07 23:16:04 +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
Matthijs Groen 0aba31de7b
docs: fix wrong code sample in docusaurus-core (#5881) 2021-11-05 22:57:59 +08:00
Molly White 95ed6e1349
docs: '5 minutes tutorial' -> '5-minute tutorial' (#5876)
* docs: fix a few instances where '5 minute tutorial' is written as '5 minutes tutorial'

* add hyphen
2021-11-05 10:58:57 +08:00
Paden Clayton fa6d15b35f
feat(core): Add React ErrorBoundary component + theme default boundaries (#3104)
Co-authored-by: Paden Clayton <paden.clayton@monkedia.com>
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2021-11-04 16:07:32 +01:00
Devtato 4922764095
docs: create SEO documentation page (#5759)
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-04 12:57:27 +01:00
琚致远 1e7f688598
docs: remove duplicated appId property (#5869) 2021-11-04 13:51:01 +08:00
Dmitriy Fishman 9f861dfb96
docs: fix a typo in using-themes.md (#5868) 2021-11-04 12:40:36 +08:00
Dmitriy Fishman d7581b38fd
docs: Fix a typo in versioning.md (#5852) 2021-11-02 14:23:06 +08:00
Devtato 41ef9daafd
feat(theme-classic): allow specifying width/height in logo (#5770)
* 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>
2021-11-01 18:09:30 +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
Joshua Chen 9247332334
feat(preset-classic): guard against unknown keys in options (#5831) 2021-10-30 12:39:12 +08:00
Sergio Moreno adbc02ea38
feat(search-algolia): algolia externalUrl regex to navigate with window.href (#5795) 2021-10-29 19:53:47 +02:00
Devtato dc5a0b7068
docs: elaborate on the usage of MDX plugins (#5766)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-10-29 16:31:00 +02: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
Sébastien Lorber a210e938e4
chore: fix Crowdin again (#5825) 2021-10-29 15:37:45 +02:00
Sébastien Lorber 157b41caee
chore: replace doc sample .pdf file by .xlsx to solve Crowdin issue (#5823) 2021-10-29 14:46:21 +02:00
Joshua Chen 7468136f88
docs: include navbar item type in the API table (#5821) 2021-10-29 18:11:07 +08:00
Dominik Meyer ab127e528d
doc: fix typo in "create a doc" (#5818)
* Update docs-create-doc.mdx

* Update docs-create-doc.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-10-29 14:48:36 +08:00
Sébastien Lorber 1ce6253cc1
chore: require Node 14 (#5812) 2021-10-28 17:11:25 +02:00
Sébastien Lorber ca5d70d7fb
docs: use "npx create-docusaurus" for init (#5797) 2021-10-27 14:46:25 +02:00
Robbie Averill 2e85848487
docs: Minor update to grammar in plugins overview page (#5771) 2021-10-27 13:06:05 +02:00
琚致远 1522c21a79
docs: update ssrTemplate (#5774)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-10-27 11:41:27 +02:00
Alexey Pyltsyn d4114c77fc
docs: fix link for apply to DocSearch program (#5784) 2021-10-25 16:03:26 +03:00
Joshua Chen 9ad6de2b85
feat(content-blog): new readingTime plugin option (#5702) 2021-10-21 15:26:10 +02:00
Sébastien Lorber 92002b6bd3
docs: rename docusaurus.config.js route + redirects cleanup (#5755) 2021-10-21 15:16:54 +02:00
Joshua Chen 2398943c17
feat(core): write-heading-ids options maintainCasing, overwrite (#5740) 2021-10-21 12:33:52 +02:00
Joshua Chen 3127f12654
feat(content-docs): new front matter options to customize pagination (#5705) 2021-10-21 12:27:57 +02:00
Thanasis Katsadas 1e0a32924b
docs(v2): Fix typo in using-plugins.md (#5750) 2021-10-20 15:38:25 +02:00
Joshua Chen ae3596df39
docs: add h4 into toc on certain pages (#5728) 2021-10-19 20:15:11 +02:00
Alexey Pyltsyn 647c8a2918
docs: fix npm init command with options (#5712)
* docs: fix npm init command with options

* Update test-release.sh
2021-10-15 16:31:15 +03:00
Alexey Pyltsyn 92104c7c3b
feat: make Translate children optional (#5683)
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-10-14 18:39:41 +02:00