3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 18:58:36 +02:00
Code Issues Projects Releases Packages Wiki Activity
6259 commits 46 branches 176 tags 872 MiB
Commit graph

65 commits

Author SHA1 Message Date
Sébastien Lorber
7cf94c03a4
feat(theme): Allow resetting colorMode to System/OS value (#10987) 
* make it work

* fix

* Try to fix accessibility issues

* add translations

* rename 'auto' to 'system'

* refactor: apply lint autofix

* rename 'auto' to 'system'

* remove title prop

* typo

* use shorter title

* refactor: apply lint autofix

* document useColorMode tradeoffs + data-attribute variables

---------

Co-authored-by: slorber <749374+slorber@users.noreply.github.com>
Co-authored-by: nasso
Co-authored-by: OzakIOne
 2025-03-14 13:45:25 +01:00
Oleksiy Gapotchenko
4d7a28963a
feat(theme): add versions attribute to docsVersionDropdown navbar item (#10852) 
Co-authored-by: sebastien <lorber.sebastien@gmail.com>
 2025-01-30 18:21:54 +01:00
Justin D Mathew
8bc3e8a092
docs(theme-live-codeblock): update theme-live-codeblock.mdx to include link to react-live (#10874) 2025-01-30 13:02:17 +01:00
Sébastien Lorber
95e2d469e3
chore: Rename Twitter links/labels to X (#10509) 2024-09-19 11:30:57 +02:00
Alice Zhao
aab1f4868b
feat(blog): group sidebar items by year (themeConfig.blog.sidebar.groupByYear) (#10252) 
Co-authored-by: sebastien <lorber.sebastien@gmail.com>
 2024-06-28 16:59:35 +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
Chongyi Zheng
dceaae41d7
chore: upgrade syntax highlighting dependencies, prism-react-renderer to v2, react-live to v4 (#9316) 
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
 2023-10-06 19:15: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
Kolja Lampe
7225d80271
docs: fix themeConfig.prism.defaultLanguage table api ref docs (#9082) 
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2023-06-22 18:30:39 +02:00
Raphaël Barbazza
509189e61f
docs: update broken links theme configuration page (#8976) 
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2023-05-15 14:37:24 +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
9c920c531b
docs: prepare docs for MDX 2 (#8782) 2023-03-16 17:02:38 +01:00
Fxpby
ca86fab2c9
docs: add description for themeConfig.footer fields copyright (#8761) 2023-03-15 19:11:35 +01:00
Sébastien Lorber
120b99b1f3
docs(website): use .mdx extension for every docs (#8490) 2022-12-30 15:08:28 +01:00
Mikey O'Toole
b7cbc967ce
docs: document theme-mermaid in API sidebar (#8417) 2022-12-06 23:45:57 -05:00
Joshua Chen
cba8be01a3
fix(theme-classic): validate options properly (#7755) 
* fix(theme-classic): validate options properly

* improve normalization

* fix doc
 2022-07-11 19:24:46 +08:00
Sébastien Lorber
42ab07f62f
feat(theme-classic): themeConfig navbar/footer logos accept className/style + update Meta Open-Source Logo (#7643) 2022-06-23 11:22:27 +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
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
6d481f6a29
docs: fix multiple typos (#7561) 2022-06-04 21:22:06 +08:00
Joshua Chen
ab566ecce3
docs: remove useless front matter (#7518) 2022-05-28 19:07:45 +08:00
Jan Peer Stöcklmair
5fcb742aa1
feat(theme-classic): allow className as option for type: "search" (#7357) 
* feat(theme-classic): allow className as option for type: "search"

* fixup! feat(theme-classic): allow className as option for type: "search"

* refactor

Co-authored-by: Jan Peer Stoecklmair <jan.peer.stoecklmair@dynatrace.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2022-05-25 18:41:05 +08:00
Joshua Chen
51815c12c9
feat(theme-classic): extensible code block magic comment system (#7178) 2022-05-04 12:31:13 +02: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
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
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
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
Alexey Pyltsyn
53c2c118c4
feat(search-algolia): allow disabling search page and configuring path (#6692) 2022-02-16 19:07:01 +01: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
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
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
4872decb42
docs: normalize CodeBlock highlighting (#6223) 2021-12-30 10:51:00 +08:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders (#6142) 2021-12-21 14:56:29 +01:00
Christopher Klint
d987c22996
feat(theme-classic): new configuration syntax for a simple footer (#6132) 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
 2021-12-20 19:45:27 +01: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
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
41ef9daafd
feat(theme-classic): allow specifying width/height in logo (#5770) 
* feat: changed the logo properties to allow width/height specification

* fixup! feat: changed the logo properties to allow width/height specification

* fixup! feat: changed the logo properties to allow width/height specification

* Rework: add fields to logo object

* Fix

* More fixes

* Wrong width!

* No need for optional chaining

* Doc writeup

Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
 2021-11-01 18:09:30 +08:00
Joshua Chen
7468136f88
docs: include navbar item type in the API table (#5821) 2021-10-29 18:11:07 +08:00
Joshua Chen
ae3596df39
docs: add h4 into toc on certain pages (#5728) 2021-10-19 20:15:11 +02:00
Sébastien Lorber
a0c2c52829
chore: remove unused Bootstrap theme (#5634) 
* remove package

* remove bootstrap from doc

* remove bootstrap init template + examples

* remove bootstrap preset

* remaining bootstrap refs

* update lockfile
 2021-10-01 17:44:34 +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
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
Alexey Pyltsyn
e6f4a9b231
docs: clarify using custom attributes for navbar link (#5423) 2021-08-26 14:29:05 +02:00
Joshua Chen
c603056f66
docs: refactor API documentation (#5219) 
* Refactor plugin-docs documentation

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Refactor theme-configuration

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Refactor plugin-blog docs

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Fix link

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* plugin-pages

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Minor change

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Interchange table columns

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Fixes

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Minor improvements

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Fix hash link

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Move blog front matter to API

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Add more blog documentation

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Update blog.md

* Update blog.md

* Update blog.md

* Update website/docs/blog.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-08-04 16:35:17 +02:00