Commit graph

1439 commits

Author SHA1 Message Date
Joshua Chen
13d07eff13
docs: refer to deployed branch as deployment rather than target (#5903) 2021-11-08 14:15:28 +08:00
Joshua Chen
c8904f1615
fix(website): fix i18n routes for Canny board (#5902) 2021-11-08 13:17:52 +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
Matej Jellus
b25031ceae
docs: Add juffalow.com to Docusaurus showcase (#5895)
* Update users.tsx

* Add juffalow.com screenshot
2021-11-07 10:35:05 +08:00
Joshua Chen
e0127c66be
chore(website): enable eslint in website (#5889)
* chore: enable eslint in website

* Fixes

* prettier users
2021-11-06 19:04:45 +08:00
Matthijs Groen
0aba31de7b
docs: fix wrong code sample in docusaurus-core (#5881) 2021-11-05 22:57:59 +08:00
Patrik Mäsiar
9c086d4a78
docs: add patrikmasiar website showcase (#5875) 2021-11-05 10:30:40 +01: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
Alexey Pyltsyn
9f13f8f7af
misc: show only latest archive alpha/beta versions dropdown (#5862) 2021-11-03 17:41:27 +01:00
Alexey Pyltsyn
91ec2509b7
chore: prepare v2.0.0-beta.9 release (#5859)
* chore: prepare v2.0.0-beta.9 release

* v2.0.0-beta.9
2021-11-02 20:40:01 +03: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
Jeffrey Aven
9723360ae9
Add InfraQL product docs website (#5847)
* Add InfraQL product docs website

* added screenshot
2021-11-01 10:10:29 +08:00
Joshua Chen
1e1df74838
docs: fix i18n routes to feature requests (#5843)
* docs: fix i18n routes to feature requests

* Add redirect rules
2021-10-31 13:32: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
Joshua Chen
9d69a0ef32
docs: add @Josh-Cena to the team (#5820)
* docs: add @Josh-Cena to the team

* Sort in alphabetical order
2021-10-29 17:29:43 +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
Joshua Chen
7a6607cfa1
refactor: remove a few Lodash usages & ESLint enforcement (#5807)
* refactor: remove some lodash usage

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Enforce ESLint

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* More forbids

* Fixup

* Fix

* Fix website
2021-10-28 12:48:58 +08: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
Sébastien Lorber
68a116611f
chore: prepare v2.0.0-beta.8 release (#5762) 2021-10-21 18:52:17 +02:00
Sébastien Lorber
31ad8c4def
fix(ideal-image): fix IdealImage in dev not handling ES import images properly (#5760) 2021-10-21 17:22:49 +02:00
Joshua Chen
1c8b8362f7
fix(live-codeblock): render static codeblock server-side (#5754)
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-10-21 17:17:03 +02: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
Sébastien Lorber
29d13351a4
fix(content-blog): temporarily swallow feed mdxToHtml errors + feed refactor (#5753) 2021-10-21 11:57:47 +02:00
Thanasis Katsadas
1e0a32924b
docs(v2): Fix typo in using-plugins.md (#5750) 2021-10-20 15:38:25 +02:00
Joshua Chen
90098ca838
refactor(module-type-aliases): remove fallback aliases (#5726) 2021-10-20 15:27:16 +02:00
Xuqian
02858ba79f
docs(v2): Add Fenghua Frontend Developer site to showcase page (#5727)
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-10-20 13:12:15 +02:00
Andrew Taft
059c05248a
docs: Add plugin-image-zoom (#5746) 2021-10-20 12:39:10 +02:00
Joshua Chen
ae3596df39
docs: add h4 into toc on certain pages (#5728) 2021-10-19 20:15:11 +02:00