Commit graph

55 commits

Author SHA1 Message Date
ozaki
fd49301a45
feat(core): make broken link checker detect broken anchors - add onBrokenAnchors config (#9528)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2024-01-04 12:56:20 +01:00
domeav
61116e2ad6
docs: Crowdin + MT issue (#9620)
Co-authored-by: Dominique Eav <dominique.eav@blue-mind.net>
2023-12-09 00:01:43 +01:00
Sébastien Lorber
4e150d2b82
docs: add Docusaurus v3.0 upgrade guide (#9417) 2023-10-19 19:38:32 +02:00
Chongyi Zheng
45f1a669b5
feat(core): support TypeScript + ESM configuration (#9317)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2023-10-14 02:46:03 +02:00
Surav Shrestha
ae3191654c
docs: fix typos in website/docs/i18n/i18n-git.mdx (#9396) 2023-10-12 18:45:14 +02:00
Sébastien Lorber
f5ae537d3e
fix(theme): make warning a first-class admonition, and deprecate caution admonition (#9308) 2023-09-15 10:48:21 +02:00
Sébastien Lorber
a59aead1e2
chore: attempt to fix Crowdin issues (#9220) 2023-08-12 02:56:54 +02:00
Sébastien Lorber
bf913aea2a
feat: upgrade to MDX v2 (#8288)
Co-authored-by: Armano <armano2@users.noreply.github.com>
2023-04-21 19:48:57 +02:00
Will Ceolin
10f161d578
feat(theme): add queryString option to localeDropdown (#8915)
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2023-04-21 12:35:02 +02:00
Sébastien Lorber
120b99b1f3
docs(website): use .mdx extension for every docs (#8490) 2022-12-30 15:08:28 +01:00
mcallisto
97ca090223
docs: add i18n guide doc should link to i18n core config doc (#8392) 2022-11-30 13:43:28 +01:00
Joshua Chen
6514f0784b
docs: add caveat about using Translate in string contexts (#8115) 2022-09-19 10:59:15 -04:00
Joe Williams
7ab2bd3234
docs: improve crowdin guide (#7861) 2022-08-03 01:38:25 +08:00
Joshua Chen
e12a2efaeb
docs: normalize capitalization (#7619) 2022-06-15 13:04:33 +08:00
dht
5c9e4a2dcd
docs: make localhost links clickable (#7582)
* docs: clickable localhost links

* revert changes in auto-generated examples folder

Co-authored-by: dht <dht@users.noreply.github.com>
2022-06-08 14:33:50 +08:00
Joshua Chen
c03def7d5f
docs: wrap more JSX in mdx-code-block (#7568) 2022-06-05 15:41:06 +08:00
Joshua Chen
ab566ecce3
docs: remove useless front matter (#7518) 2022-05-28 19:07:45 +08:00
Joshua Chen
9fd5d62340
docs: enhance docs about Markdown TOC and metadata (#7278)
* docs: multiple documentation improvements

* fix

* fix
2022-04-30 21:30:14 +08:00
Joshua Chen
743738d8c6
docs: add documentation about pluralization (#7236) 2022-04-24 11:23:28 +08:00
Joshua Chen
ff96606865
docs: fix some casing inconsistencies (#7081) 2022-03-31 20:23:44 +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
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
Joshua Chen
cbcbdaa9d3
docs: elaborate on i18n tutorial (#6428) 2022-01-21 21:25:03 +08:00
Joshua Chen
96dbb8e7ef
feat(website): improve prism themes (#6214)
* feat(website): modify Prism dark theme

* update

* Use vsDark

* update crowdin config

* fix light theme as well

* revert comment changes
2021-12-29 21:25:01 +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
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders (#6142) 2021-12-21 14:56:29 +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
Sébastien Lorber
ca5d70d7fb
docs: use "npx create-docusaurus" for init (#5797) 2021-10-27 14:46:25 +02:00
Joshua Chen
ae3596df39
docs: add h4 into toc on certain pages (#5728) 2021-10-19 20:15:11 +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
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
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
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
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
Костя Третяк
09d107969c
docs(v2): fix i18n doc: bad i18n page plugin path in code sample (#4773)
* fix(docs): fixed "Translate the pages"

* Update website/docs/i18n/i18n-tutorial.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-05-12 14:39:24 +02:00
Sébastien Lorber
db79d462ab
feat(v2): auto-generated sidebars, frontmatter-less sites (#4582)
* POC of autogenerated sidebars

* use combine-promises utility lib

* autogenerated sidebar poc working

* Revert "autogenerated sidebar poc working"

This reverts commit c81da980

* POC of auto-generated sidebars for community docs

* update tests

* add initial test suite for autogenerated sidebars + fix some edge cases

* Improve autogen sidebars: strip more number prefixes in folder breadcrumb + slugs

* fix typo!

* Add tests for partially generated sidebars + fix edge cases + extract sidebar generation code

* Ability to read category metadatas file from a file in the category

* fix tests

* change position of API

* ability to extract number prefix

* stable system to enable position frontmatter

* fix tests for autogen sidebar position

* renamings

* restore community sidebars

* rename frontmatter position -> sidebar_position

* make sidebarItemsGenerator fn configurable

* minor changes

* rename dirPath => dirName

* Make the init template use autogenerated sidebars

* fix options

* fix docusaurus site: remove test docs

* add _category_ file to docs pathsToWatch

* add _category_ file to docs pathsToWatch

* tutorial: use sidebar_position instead of file number prefixes

* Adapt Docusaurus tutorial for autogenerated sidebars

* remove slug: /

* polish the homepage template

* rename _category_ sidebar_position to just "position"

* test for custom sidebarItemsGenerator fn

* fix category metadata + add link to report tutorial issues

* fix absolute path breaking tests

* fix absolute path breaking tests

* Add test for floating number sidebar_position

* add sidebarItemsGenerator unit tests

* add processSidebars unit tests

* Fix init template broken links

* windows test

* increase code translations test timeout

* cleanup mockCategoryMetadataFiles after windows test fixed

* update init template positions

* fix windows tests

* fix comment

* Add autogenerated sidebar items documentation + rewrite the full sidebars page doc

* add useful comment

* fix code block title
2021-04-15 16:20:11 +02:00
Arijit Kundu
4a219f1983
docs(v2); fixed broken link i18n-tutorial.md (#4558) 2021-04-05 19:00:54 +02:00
Arijit Kundu
d324dc3869
docs(v2): fixed the directory of index.js (#4559) 2021-04-05 18:56:14 +02:00
besemuna
9715048f79
feat(v2): provide doc sidebar_label through sidebars.js (#4500)
* feat : update SidebarItemDoc type

* feat : update assertIsDoc

* feat : allow configuring title from sidebar.js

* feat : add docs

* docs : refactor i18n docs to use label in sidebar.js

* test : add test

* Update website/docs/guides/docs/sidebar.md

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

* docs : remove backported docs

Co-authored-by: Lisa Chandra <52909743+lisa761@users.noreply.github.com>
Co-authored-by: Javid <singularity.javid@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-03-26 15:11:21 +01: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
dd5e5098b8
docs(v2): Add missing i18n docs: API lifecycles + Crowdin migration guide (#4470)
* Add the missing i18n docs: Crowdin migration + i18n lifecycle APIs

* fix heading ids

* fix doc typo
2021-03-19 18:19:30 +01:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Sébastien Lorber
806fdbaf27
feat(v2): infer default i18n locale config from locale code (#4449)
* improve locale default config

* remove localeConfigs from i18n tutorial

* better i18n types, tests and Intl.DisplayNames integration
2021-03-18 11:43:07 +01:00
Sébastien Lorber
b7a6665d31
docs(v2): releasing i18n blog post (#4367)
* add social card

* Complete the i18n blog post

* update blog post

* add missing v1 images

* improve the blog post

* update blog post

* update blog post

* fix bad file-system wording

* add mention of dogfooding

* translate the blog post into french + mention it!
2021-03-09 19:44:36 +01:00
Alexey Pyltsyn
1c7d423e0c
docs(v2): various improvements (#4369)
* docs(v2): various improvements

* Update blog.md
2021-03-09 14:59:32 +01:00
Alexey Pyltsyn
96e7fcef25
feat(v2): add ability to set custom heading id (#4222)
* feat(v2): add ability to set custom heading id

* Add cli command

* Fix slugger

* write-heading-ids doc + add in commands/templates

* refactor + add tests for writeHeadingIds

* polish writeHeadingIds

* polish writeHeadingIds

* remove i18n goals todo section as the  remaining items are quite abstract/useless

* fix edge case with 2 md links in heading

* extract parseMarkdownHeadingId helper function

* refactor using the shared parseMarkdownHeadingId utility fn

* change logic of edge case

* Handle edge case

* Document explicit ids feature

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-05 19:36:14 +01:00
Sébastien Lorber
1734975f2f
feat(v2): Add Interpolate / interpolate APIs + complete theme translations (#4295)
* WIP: refactor team profile cards

* Add Interpolate / interpolate APIs

* Add interpolate snapshot test

* comments

* fix Interpolate TS types

* Interpolate should handle numbers and other JS types

* translate BlogPostItem

* interpolate translate() fn + add translations for blog post tag header

* localize the LastUpdated component

* translate DocVersionSuggestions

* fix test

* add some new translations

* Add node script to easily update the theme default translations

* fix translation extractor bug due to translate() dynamic values

* use ICU placeholder syntax

* refactor month key

* order

* team  page translation improvements

* Add interpolation doc + improve i18n doc
2021-02-26 13:19:51 +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
0ac34b75c5
feat(v2): add support for RTL direction (#4140)
* feat(v2): add support for RTL

* Move to i18n config

* Move direction to localeConfigs

* Create RTL styles for Docusaurus styles (via new hook)

* update infima to alpha 19

* fix minor type error

* Fix build

* Cleanup

* polish RTL support

* polish RTL support

* revert english rtl dir

* minor RTL fix

* minor doc updates

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-02-10 10:52:26 +01:00