Commit graph

143 commits

Author SHA1 Message Date
Massoud Maboudi
a0b060759d
docs: fix translation config example (#7396) 2022-05-11 14:35:19 +08:00
Joshua Chen
6e10a48059
fix(content-docs): restore functionality when a category only has index page (#7385)
* fix(content-docs): restore functionality when a category only has index page

* use this internally
2022-05-10 14:50:43 +08:00
Joshua Chen
0cc4fa82c1
docs: add page for create-docusaurus API documentation (#7343)
* docs: add page for create-docusaurus API documentation

* update
2022-05-05 19:36:51 +08:00
Joshua Chen
51815c12c9
feat(theme-classic): extensible code block magic comment system (#7178) 2022-05-04 12:31:13 +02:00
Joshua Chen
785fed723f
refactor(theme-classic): move all sidebar-related config under themeConfig.docs.sidebar (#7277) 2022-05-04 12:08:19 +02:00
Joshua Chen
7a3894e664
docs: update docs for logger, add API docs to website (#7305)
* docs: update docs for logger, add API docs to website

* fix broken image
2022-05-04 17:59:47 +08:00
Joshua Chen
5bed55aeda
refactor(types): JSDoc for docusaurus config fields (#7291) 2022-05-03 13:57:19 +08:00
Joshua Chen
afc72480ab
refactor(eslint-plugin): migrate to TS-ESLint infrastructure (#7276)
* refactor(eslint-plugin): migrate to TS-ESLint infrastructure

* fix lock
2022-04-30 17:57:57 +08:00
Elias Papavasileiou
3b1170eb44
feat: Docusaurus ESLint plugin to enforce best Docusaurus practices (#7206)
* feat: add eslint plugin

* refactor

* add tests

* fixups!

* fix(no-dynamic-i18n-messages): make translate() recognize template literals

* refactor: rename rule no-dynamic-i18n-messages --> string-literal-i18n-messages

* feat: add ignoreStrings option and refactor

* docs: migrate docs to /docs/api/plugins

* docs: fix anchor links in README.md

* fix: add some ignored strings

* docs: update eslint-plugin docs

* fix: update README link

* docs: various updates

- Reorder sidebar entries
- Fix title size
- Use Markdown file paths
- Simplify relative links

* address reviews

* wording polish

* add npmignore

* fix all internal warnings

* doc improvements

* fix test

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-30 00:04:25 +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
Alexey Pyltsyn
84d04ed6ed
feat(theme-classic): new 'html' type navbar item (#7058)
* feat(theme-classic): allow using html in dropdown items

* Fix tests

* Introduce HTML type for navbar item

* Update packages/docusaurus-theme-classic/src/theme/NavbarItem/HtmlNavbarItem.tsx

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

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-15 18:58:15 +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
Joshua Chen
7941a46be3
feat: allow setting calendar for i18n date formatting (#6430)
* feat: allow setting calendar for i18n date formatting

* fix TS

* add test
2022-04-08 22:34:34 +08:00
Alexey Pyltsyn
bfbc78e52a
feat: allow using pure HTML as label in navbar links (#7079)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-04-07 12:33:52 +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
24c205a835
refactor: replace non-prop interface with type; allow plugin lifecycles to have sync type (#7080)
* refactor: replace non-prop interface with type; allow plugin lifecycles to have sync type

* fix
2022-03-31 19:16:07 +08:00
Joshua Chen
77662260f8
refactor(core): refactor routes generation logic (#7054)
* refactor(core): refactor routes generation logic

* fixes
2022-03-29 16:37:29 +08: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
Alexey Pyltsyn
ecbe0b26c5
refactor(theme-{classic,common}): refactor ColorModeToggle + useColorMode() hook (#6930)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2022-03-18 15:28:35 +01:00
Joshua Chen
68aaf9201f
feat(core): allow plugin lifecycles to return relative paths (#6921)
* feat(core): resolve plugin lifecycles returning relative paths

* fix typo

* fix tests

* revert

* rename path -> entryPath
2022-03-16 20:47:15 +08: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
Joshua Chen
2a7120cc02
docs: mention configureWebpack devServer return value (#6881) 2022-03-09 20:23:38 +08:00
Joshua Chen
7ec44bb32c
refactor(theme-classic): replace color mode toggle with button; remove switchConfig (#6771)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-03-02 15:57:17 +01:00
Joshua Chen
908ad52025
docs: add basic documentation about client modules (#6772) 2022-02-26 18:25:19 +08:00
Joshua Chen
9562a5d203
refactor: remove deprecated Webpack utils & validation escape hatch (#6740) 2022-02-23 11:40:58 +01:00
Alexey Pyltsyn
53c2c118c4
feat(search-algolia): allow disabling search page and configuring path (#6692) 2022-02-16 19:07:01 +01: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
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
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
76a8d5f38a
fix(content-blog): generate feed by reading build output (#6454) 2022-01-26 16:54:15 +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
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
Nick Schonning
2528226eeb
chore: add height/width for front page images (#6385)
* chore: add height/width for Lighthouse performance

* use auto width

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-23 09:57:31 +08:00
Joseph
8ce3cee400
feat(theme-classic): auto-collapse sibling categories in doc sidebar (#3811)
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2022-01-20 16:38:16 +01:00
Joshua Chen
d506bca12d
feat(content-blog): allow disabling generating archive (#6415) 2022-01-20 14:52:19 +01:00
Yaroslav Serhieiev
d296f44031
docs(i18n): amend PR #6371 (#6406) 2022-01-19 18:19:41 +01:00
Joshua Chen
db471d97ab
fix(website): various anchor link fixes (#6318) 2022-01-12 08:35:47 +08:00
Sébastien Lorber
f87a3ead46
refactor: move @theme/hooks to @docusaurus/theme-common (#6289) 2022-01-07 19:19:35 +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
Minh Pham
eade41a702
feat(theme-classic): new navbar item linking to a sidebar (#6139)
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-01-06 11:52:25 +01:00
Joshua Chen
8fe1ddf46a
feat(sitemap): remove trailingSlash option; respect noIndex config (#6248) 2022-01-05 17:56:17 +01:00
Joshua Chen
4872decb42
docs: normalize CodeBlock highlighting (#6223) 2021-12-30 10:51:00 +08: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