Commit graph

179 commits

Author SHA1 Message Date
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 | 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
Sébastien Lorber
7e4d7671c8
chore(v2): prepare v2.0.0-beta.0 release (#4774)
* beta.0 version docs + changelog

* fix config for beta switch

* v2.0.0-beta.0
2021-05-12 16:07:15 +02:00
Sébastien Lorber
0ef0d27c51
chore(v2): prepare v2.0.0.alpha-75 release (#4707)
* alpha 75

* v2.0.0-alpha.75
2021-04-30 18:41:55 +02:00
Sébastien Lorber
6f29a1826a
chore(v2): prepare v2.0.0.alpha-74 release (#4690)
* alpha 74

* v2.0.0-alpha.74
2021-04-27 16:38:56 +02:00
Sébastien Lorber
4d49945775
chore(v2): prepare v2.0.0.alpha-73 release (#4628)
* add changelog

* add alpha 73

* run prettier on versions file (+ ignore it as we don't care much and it's annoying when releasing)

* v2.0.0-alpha.73
2021-04-16 12:48:10 +02:00
Dick Wyn Yong
de9f414919
docs(v2): add clarity to tip in versioned using-themes page (#4609) 2021-04-13 19:59:50 +02:00
Arijit Kundu
d324dc3869
docs(v2): fixed the directory of index.js (#4559) 2021-04-05 18:56:14 +02:00
Arijit Kundu
ecc3444865
docs(v2): fixed typos (#4560)
* docs(v2): fixed typos

* docs(v2): fixed typos
2021-04-05 18:42:41 +02:00
Sébastien Lorber
78349480af
chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups (#4490)
* prepare v1-v2 domain switch

* rename v1 changelog as CHANGELOG-1.x.md

* switch v1/v2 changelogs

* Cleanup v2.docusaurus.io urls

* add netlify domain redirect

* remove circleci config

* remove another circle file
2021-03-22 20:57:49 +01:00
Sébastien Lorber
aaea26602b
chore: prepare v1-v2 domain switch (#4475)
* prepare v1-v2 domain switch

* rename v1 changelog as CHANGELOG-1.x.md

* switch v1/v2 changelogs
2021-03-22 20:26:47 +01:00
Arijit Kundu
af840b7f85
docs(v2, v1): fixed typos (#4479) 2021-03-22 18:00:32 +01:00
Arijit Kundu
be6ef076f0
docs(v2): corrected the use of delimiters (#4478) 2021-03-21 12:23:08 +03:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Alexey Pyltsyn
1135d19333
chore(v2): remove docs for alpha v70 (#4457) 2021-03-18 18:36:58 +03:00
Alexey Pyltsyn
f8fda885fc
chore(v2): prepare v2.0.0.alpha-72 release (#4440)
* chore(v2): prepare v2.0.0.alpha-72 release

* v2.0.0-alpha.72
2021-03-16 14:30:54 +03:00
Long Ho
1078341b22
refactor(v2): i18n cleanups / refactors (#4405)
* chore: fix various intl stuff
- remove intl-locales-supported & intl since they're deprecated and only
needed for IE11
- add new polyfills for node 12
- clean up babel intl extractor
- reset jest test timezone to UTC so it passes even for East Coast
contributor

* chore: change build to include Node 14

* docs: update i18n reqs
2021-03-15 18:02:53 +01:00
Sébastien Lorber
986de6b214
chore(v2): prepare v2.0.0.alpha-71 release (#4376)
* prepare release

* v2.0.0-alpha.71
2021-03-09 18:45:05 +01:00
Alexey Pyltsyn
3cbfb4cc60
chore(v2): remove docs for alpha v69 (#4289) 2021-02-24 20:41:09 +03:00
Sébastien Lorber
cc42cf5af7
docs(v2): escape more jsx in mdx files for Crowdin (#4285) 2021-02-24 15:46:00 +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
Alexey Pyltsyn
67ff0a3c0c
chore(v2): remove docs for alpha v68 (#4253) 2021-02-19 20:45:20 +03:00
Yash Totale
cf080c72ba
docs(v2): fix npm/yarn command example for swizzling TypeScript theme components (#4230) 2021-02-17 12:28:36 +01:00
Sam Zhou
bb63e093f1
docs(v2): Fix link to slash introduction svg (#4229) 2021-02-17 12:06:58 +01:00
Juan Carlos Blanco Delgado
2ff5d347ba
docs(v2): Removing wrong parenthesis on image variable (#4226)
* Removing wrong parenthesis on image variable

* Updating markdown feature documenation
2021-02-16 09:28:54 +01:00
Yuval Hazaz
24b1695adc
docs(v2): add a note for images not rendered on dev server (#4164)
* Update plugin-ideal-image.md

Add a note that images are not rendered on the development server

* Update plugin-ideal-image.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-02-03 15:38:47 +01:00
TaeSeong Park
e53d63b769
docs(v2): Fix file path in "Wrapper your site with <Root>" (website/docs/using-themes.md) 2021-02-01 10:52:22 +01:00
Alexey Pyltsyn
e030d34437
chore(v2): remove docs for alpha v66 (#4100) 2021-01-25 17:35:13 +03:00