Commit graph

141 commits

Author SHA1 Message Date
Hyunseung Lee
8da73a082f
docs: update workbox doc link (#7835)
* Update plugin-pwa.md

* Update plugin-pwa.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-08-01 13:34:57 +08:00
Joshua Chen
4b5a47ba37
feat(client-redirects): make plugin respect onDuplicateRoutes config (#7649) 2022-06-22 13:32:02 +02:00
Sébastien Lorber
6df379ca6f
fix(docs): forward doc frontMatter.sidebar_custom_props to linking sidebar category (#7638) 2022-06-16 19:20:07 +02:00
Joshua Chen
e12a2efaeb
docs: normalize capitalization (#7619) 2022-06-15 13:04:33 +08:00
Joshua Chen
aeb6c971c0
docs: normalize capitalization (#7613) 2022-06-14 14:01:06 +08:00
Joshua Chen
fb3138d722
refactor(client-redirects): elaborate documentation, minor refactor (#7607) 2022-06-13 22:04:39 +08:00
Joshua Chen
7869e74fd7
refactor(pwa): simplify registerSW code, fix ESLint errors (#7579) 2022-06-07 21:42:17 +08:00
Joshua Chen
bf9b69cfbf
docs: make config tabs translatable, fix APITable crowdin issue (#7572)
* docs: make config tabs translatable, fix APITable crowdin issue

* fix
2022-06-06 10:52:19 +08:00
Joshua Chen
c03def7d5f
docs: wrap more JSX in mdx-code-block (#7568) 2022-06-05 15:41:06 +08:00
dpang314
4f26a1911a
feat(content-docs): last_update front matter (#7461)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-06-01 16:27:58 +02:00
Joshua Chen
ab566ecce3
docs: remove useless front matter (#7518) 2022-05-28 19:07:45 +08:00
Joshua Chen
7ab97d4726
feat(sitemap): allow customizing the output name (#7469)
* feat(sitemap): allow customizing the output name

* add docs
2022-05-27 22:30:59 +08:00
Joshua Chen
1a5e33c717
refactor(pwa): remove reloadPopup option in favor of swizzling (#7422)
* refactor(pwa): remove reloadPopup option in favor of swizzling

* restore code splitting

* add deprecation
2022-05-27 20:32:22 +08:00
James
4f97c7b52c
docs: link every reference of types in API table to the type definition (#7497)
* dogfood fix

* feat: links for plugin types

* better syntax

* little refactor

* use code title

* complete the rest

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-05-26 15:06:36 +08:00
Joshua Chen
cd21a31005
test: strengthen internal types (#7488) 2022-05-25 15:38:44 +08:00
Joshua Chen
5bed55aeda
refactor(types): JSDoc for docusaurus config fields (#7291) 2022-05-03 13:57:19 +08:00
John Reilly
b747143982
docs: update gtag docs to reflect what a GA4 tag looks like (#7252) 2022-04-28 09:05:25 +08:00
Jody Heavener
5fb0a2e274
feat(content-docs): draft docs excluded from build & sidebars (#6457)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-13 18:02:05 +02:00
ApsarasX
103ea04661
feat(sitemap): add ignorePatterns option (#6979)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-06 15:44:07 +02:00
Joshua Chen
2bcac29cd4
refactor(content-docs): deduplicate types, JSDoc for some APIs (#7027)
* refactor(content-docs): deduplicate types, JSDoc for some APIs

* little refactor
2022-03-27 12:57:15 +08:00
Joshua Chen
b5ceead3b2
feat(content-docs): autogenerate category with linked doc metadata as fallback (#6859) 2022-03-25 15:23:11 +01:00
Joshua Chen
8d1c1954c1
refactor(content-blog): clean up type definitions; in-code documentation (#6922)
* refactor(content-blog): clean up type definitions; in-code documentation

* add doc
2022-03-16 19:36:57 +08:00
Jody Heavener
3629b5ab39
feat(docs,theme-classic): docs breadcrumbs (#6517)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-16 19:02:58 +01:00
Joshua Chen
3fd99ad8d4
feat(content-blog): allow customizing blog archive component through option (#6603)
* feat(content-blog): allow customizing blog archive component through option

* fix
2022-02-04 18:56:09 +08:00
Joshua Chen
1ca07f8466
refactor(content-docs): read category metadata files before autogenerating (#6586)
* refactor(content-docs): read category metadata files before autogenerating

* fix tests

* fix Windows...

* warn user when behavior is undetermined

* oops

* fix typo
2022-02-03 16:16:19 +08:00
Tamal Web
ade486d079
docs: mention where to find the sitemap (#6492)
* Added the sitemap url

So that users know where to locate their sitemaps

* Update plugin-sitemap.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-28 17:11:09 +08:00
Joshua Chen
24a895fbc5
feat(content-docs): expose isCategoryIndex matcher to customize conventions (#6451)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-01-26 17:58:52 +01:00
Joshua Chen
59022c5eea
docs: add advanced guides (#6296)
* docs: add advanced guides

* complete

* fix link

* Create architecture

* use png

* explanations

* more text

* process.env.NODE_ENV

* typo

* Add image zoom

* nit

* nit

* reorganize

* fix links

* fix links

* reorganize

* elaborate on presets

* fix

* routing docs

* ssr section

* more content

* complete SSR guide

* pathname://

* improvements

* document executionenvironment

* reformat

* final tweaks!

* avoid slug

* oops
2022-01-25 11:29:18 +08:00
Joshua Chen
d506bca12d
feat(content-blog): allow disabling generating archive (#6415) 2022-01-20 14:52:19 +01:00
Joshua Chen
06a8cdcb0f
docs: elaborate on doc versioning (#6280)
* docs: elaborate on doc versioning

* Complete

* fix
2022-01-07 14:28:48 +08:00
Joshua Chen
a03788374e
fix(website): fix config-tabs breaking after translation (#6275)
* fix(website): fix config-tabs breaking after translation

* more robust
2022-01-06 19:31:58 +08:00
Joshua Chen
8fe1ddf46a
feat(sitemap): remove trailingSlash option; respect noIndex config (#6248) 2022-01-05 17:56:17 +01:00
Joshua Chen
5132ecdeee
docs: normalize plugin API documentation (#6193)
* docs: normalize plugin API documentation

* Revert change

* Use remark plugin

* edits

* edit again

* Fixes
2021-12-28 21:23:27 +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
e1bff072fe
feat(ideal-image): new option disableInDev (#6155)
* feat(ideal-image): new option disableInDev

* Add docs

* Use import type

* More docs
2021-12-25 21:48:38 +08:00
John Reilly
a17deb6aa2
docs: remove mention of 'UA-' in gtag (#6184) 2021-12-24 17:21:31 +08:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders (#6142) 2021-12-21 14:56:29 +01:00
不郑
7e5f6bb805
feat(content-blog): support json feed (#6126)
* feat(content-blog): support json feed

* feat(content-blog): support json feed

* feat(content-blog): add json type to default feed options

* Refactors, docs, validation

* Fix test

* Ammend docs

* Add API doc

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-18 22:47:40 +08:00
Sébastien Lorber
cfae5d0933
feat(content-docs): sidebar category linking to document or auto-generated index page (#5830)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Armano <armano2@users.noreply.github.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-12-03 14:44:59 +01: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
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
Robbie Averill
2e85848487
docs: Minor update to grammar in plugins overview page (#5771) 2021-10-27 13:06:05 +02:00
Joshua Chen
9ad6de2b85
feat(content-blog): new readingTime plugin option (#5702) 2021-10-21 15:26:10 +02:00
Joshua Chen
3127f12654
feat(content-docs): new front matter options to customize pagination (#5705) 2021-10-21 12:27:57 +02:00
Joshua Chen
eaacb0e98a
feat(theme-classic, plugin-docs): sidebar item level-specific className + allow customization (#5642)
* Initial work

* Complete function

* Avoid duplication

* More dedupe

* Make everything constants

* Change casing & docs
2021-10-07 16:59:02 +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
Erick Zhao
c86dfbda61
feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (#5578)
* feat: add all TOC levels to MDX loader

* feat: add theme-level config for heading depth

* test: add remark MDX loader test

* fix: limit maxDepth validation to H2 - H6

* refactor: set default `maxDepth` using `joi`

* refactor: `maxDepth` -> `maxHeadingLevel

* refactor: invert underlying TOC depth API

* refactor: make TOC algorithm level-aware

* feat: add support for per-doc TOC heading levels

* feat: support document-level heading levels for blog

* fix: correct validation for toc level frontmatter

* fix: ensure TOC doesn't generate redundant DOM

* perf: simpler TOC heading search alg

* docs: document heading level props for `TOCInline`

* Update website/docs/guides/markdown-features/markdown-features-inline-toc.mdx

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* docs: fix docs (again)

* create dedicated  test file for heading searching logic: exhaustive tests will be simpler to write

* toc search: add real-world test

* fix test

* add dogfooding tests for toc min/max

* add test for min/max toc frontmatter

* reverse min/max order

* add theme minHeadingLevel + tests

* simpler TOC rendering logic

* simplify TOC implementation (temp, WIP)

* reverse unnatural order for minHeadingLevel/maxHeadingLevel

* add TOC dogfooding tests to all content plugins

* expose toc min/max heading level frontmatter to all 3 content plugins

* refactor blogLayout: accept toc ReactElement directly

* move toc utils to theme-common

* add tests for filterTOC

* create new generic TOCItems component

* useless css file copied

* fix toc highlighting className conflicts

* update doc

* fix types

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-29 11:19:11 +02:00