Commit graph

205 commits

Author SHA1 Message Date
Joshua Chen
1d957d97e8
fix(migrate): migration CLI should correctly migrate gtag options (#6276)
* fix(migrate): migration CLI should correctly migrate gtag options

* fix
2022-01-06 20:39:23 +08:00
Joshua Chen
5dcfa8fa23
docs: fix import module name of theme/Admonition (#6164) 2021-12-22 22:11:11 +08:00
Sébastien Lorber
fb7e98a345
docs: remove useless comment (#6159) 2021-12-22 12:52:40 +01:00
Sébastien Lorber
01b407011a
chore(v2): prepare v2.0.0-beta.14 release (#6147) 2021-12-21 17:15:04 +01:00
Joshua Chen
9078fd9fb2
docs: refactor & refine lifecycle API docs (#5918)
* docs: refactor & refine lifecycle API docs

* Fix links

* More writeup

* Rewording

* Rename path

* Use README

* Fix links

* Add redirects

* Do the same for latest version as well

* Move folder

* Fix broken link
2021-12-21 14:54:04 +08:00
Joshua Chen
7db4884853
refactor(website): make deploy preview open next version docs by default (#6120)
* refactor(website): make deploy preview open next version docs by default

* Fix links
2021-12-17 11:00:12 +08:00
Sébastien Lorber
ae9a12ff50
chore(v2): prepare v2.0.0-beta.13 release (#6084) 2021-12-10 16:56:00 +01:00
Sébastien Lorber
991c1b2832
chore(v2): prepare v2.0.0-beta.11 release (#6081) 2021-12-10 14:13:25 +01:00
Sébastien Lorber
43ac7d5da9
chore(v2): prepare v2.0.0-beta.10 release (#6076) 2021-12-09 13:32:23 +01: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
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
Joshua Chen
ecce576bbc
docs: new APITable comp to render large tables (#5891) 2021-11-10 11:38:23 +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
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
Joshua Chen
9247332334
feat(preset-classic): guard against unknown keys in options (#5831) 2021-10-30 12:39:12 +08: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
Sébastien Lorber
ca5d70d7fb
docs: use "npx create-docusaurus" for init (#5797) 2021-10-27 14:46:25 +02: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
92002b6bd3
docs: rename docusaurus.config.js route + redirects cleanup (#5755) 2021-10-21 15:16:54 +02:00
Alexey Pyltsyn
f9fd8efbf4
chore: remove beta.5 docs (#5719) 2021-10-16 09:17:07 +03:00
Alexey Pyltsyn
877373e108
chore: prepare v2.0.0-beta.7 release (#5713)
* chore: prepare v2.0.0-beta.7 release

* v2.0.0-beta.7
2021-10-15 16:31:01 +03:00
Sébastien Lorber
f6ec757aa0
feat: npm init docusaurus, yarn create docusaurus (#5635)
* initial create-docusaurus impl

* cleanup

* @docusaurus/init renamed to create-docusaurus

* 0.0.6

* update lockfile

* fix lint

* remove npm2yarn for "npm init" because npm2yarn doesn't convert it and yarn result fails to execute

* prettier

* add correct version

* prettier

* prettier

* prettier

* prettier

* fix annoying --config .prettierrc issue
2021-10-07 16:06:42 +02:00
Joshua Chen
3f1f8255a2
chore: upgrade Prettier + regenerate lock file (#5611)
* Bump deps

* Run prettier

* Format docs

* Minor refactor

* Collapse objects

* Fix type

* Update lock file
2021-09-30 12:54:17 +02:00
Forresst
02eee61aa5
docs: improve escape pipe in Markdown tables (#5539)
* Test escape pipe in Markdown table 

From a remark on Crowdin:
> The value for the Type entry in the plugin-content-blog page is strange.
> In English documents, the Type item value is normally displayed.
> ex) editUrl: string | EditUrlFunction
> However, in French documentation, the Type item value is shown as an unknown code.
> ex) editUrl:!!crwdBlockTags_249_sgaTkcolBdwrc!!
> ex) blogSidebarCount: !!crwdBlockTags_250_sgaTkcolBdwrc!!

This is a test to see if the other way to escape a pipe in a markdown table could solve the problem.

* Fix all docs to replace &#124; by \|

* Keep `code`

* Apply suggestions from code review

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-09-08 14:58:48 +03: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
Sébastien Lorber
fd3c0c6619
chore: remove beta.4 docs (already archived) (#5474) 2021-09-02 18:56:22 +02:00
Sébastien Lorber
2611bbb501
chore(v2): prepare v2.0.0-beta.6 release (#5473)
* add beta.6

* v2.0.0-beta.6
2021-09-02 18:31:42 +02:00
Sébastien Lorber
f600d5a6d7
chore: prepare v2.0.0-beta.5 release (#5427)
* beta.5

* v2.0.0-beta.5
2021-08-26 17:33:31 +02:00
Sébastien Lorber
f40ce05102
refactor: clean Canny integration + rename 'Feedback' to 'Feature Requests' + improve TS doc page (#5389)
* Better Canny integration

* Add missing netlify redirects

* polish

* TS doc: mention it's possible to use JSDoc in config

* issue templates: use /feature-requests new url
2021-08-20 11:42:13 +02:00
Sébastien Lorber
589a59ba8a
docs: remove docusaurus-preset-name from preset doc (#5372)
* doc: docusaurus-preset-name does not exist and is confusing for some users

* doc: docusaurus-preset-name does not exist and is confusing for some users
2021-08-17 19:38:35 +02: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
Alexey Pyltsyn
fdda2bd7fd
docs: fix broken link to syncing tab choices section (#5283) 2021-08-04 10:37:10 +03:00
Sébastien Lorber
cdc41d5bb6
misc: enable pt-BR + archive older versions (#5269)
* add pt-BR to main site!

* archive older docs
2021-08-02 16:00:31 +02:00
Sébastien Lorber
fc64c12e41
chore(v2): prepare v2.0.0-beta.4 release (#5238)
* chore(v2): prepare v2.0.0-beta.4 release

* update publish

* v2.0.0-beta.4
2021-07-28 22:54:41 +02:00
Sébastien Lorber
b3e89d2a86
feat: docusaurus.new + improved StackBlitz playground (#5235)
* Upgrade playground shortcut domain to docusaurus.new

* update generateExamples

* update generateExamples + re-generate with stackblitz config

* test

* test

* test

* test

* test

* update examples

* upgrade lockfile

* fix yarnlock

* fix yarnlock
2021-07-28 19:27:58 +02:00
Sébastien Lorber
700a82aefe
feat: multiple playground choices (#5207)
* poc of using netlify functions for playground redirections

* push

* cleanup

* restore files

* fix netlify functions?

* fix netlify functions?

* implement serverless functions for playgrounds with persistent cookie

* move new.docusaurus.io to monorepo packages

* move new.docusaurus.io to monorepo packages

* lockfile

* push

* catch-all redirect

* Translate/Interpolate: add better error message if not used correctly

* Add /docs/playground page

* Add some additional doc
2021-07-22 21:10:36 +02:00
Sébastien Lorber
4d06f26c1f
fix(v2): Fix MDX docs being considered as partials when siteDir match the _ prefix convention (#5199)
* Add _ to dogfood docs folder to cover against edge case

* Fix edge case with MDX partials when site / content dir contains a _ prefix

* add globUtils tests

* proper dogfooding folder re-organization, all content plugins being used

* refactor dogfooding folder + expose /tests page index

* fix page plugin ignoring options.routeBasePath
2021-07-21 14:13:51 +02:00
Sébastien Lorber
81170a79f4
docs(v2): Update tutorial link (#5178) 2021-07-15 14:56:41 +02:00
Sébastien Lorber
1ec2c95e3d
chore(v2): prepare v2.0.0-beta.3 release (#5098)
* beta.3

* publish guide

* publish guide

* v2.0.0-beta.3
2021-06-30 16:05:49 +02:00
Sébastien Lorber
ec2486d2c9
chore(v2): prepare v2.0.0-beta.2 release (#5056)
* prepare beta.2

* v2.0.0-beta.2
2021-06-24 19:39:37 +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
c63295a253
docs(v2): wrap mdx usage in mdx-code-block (#5007) 2021-06-18 17:59:51 +02:00
Sébastien Lorber
871e090ed8
chore: add archived versions system + archive alpha.73-75 (#5005) 2021-06-18 17:27:13 +02:00
Sébastien Lorber
8d8e5b67e8
chore(v2): prepare v2.0.0-beta.1 release (#5004)
* beta.1

* v2.0.0-beta.1
2021-06-18 16:54:46 +02: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
Sébastien Lorber
3c6a0ac97e
docs(v2): remove docs for alpha 71 + 72 (#4780) 2021-05-12 17:18:37 +02:00