Commit graph

119 commits

Author SHA1 Message Date
Mikey O'Toole
32dc1eddba
docs: clarify additionalLanguages with custom language definitions. (#8307)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-12-09 18:47:22 +01:00
mturoci
5c09dbfc3d
feat(theme-classic): store selected tab in query string. (#8225)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Closes https://github.com/facebook/docusaurus/issues/7008
2022-12-09 17:46:09 +01:00
Marco Kuper
681e6d3ea4
docs: fix links to external plugin description (#8262) 2022-12-07 17:58:01 +01:00
Waldir Pimenta
6be3beb8c9
docs: actually demo the zero-width space workaround in MDX (#8352) 2022-11-24 11:00:39 +01:00
Balthasar Hofer
b016686c22
fix(mdx-loader): support nested admonitions (#8303)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
closes undefined
2022-11-23 21:19:29 +01:00
Alex
412d2db011
docs: fix unclosed admonition code block (#8363) 2022-11-23 18:21:04 +01:00
Nathaniel Tucker
7387aabbdc
docs: fix mermaid theme options typo (#8272)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-11-02 14:31:53 +01:00
Sam Wall
9c92a79d23
feat: support mermaid code blocks in Markdown (#7490)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-10-14 18:07:20 +02:00
Sébastien Lorber
6f63ffe0a3
refactor(theme): split admonitions, make swizzle easier, better retrocompatibility (#7945)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-09-07 17:49:44 +02:00
Tom Mrazauskas
1f1f898d73
docs: delete extra semicolon in MDX and React page (#8046) 2022-09-03 14:39:06 -04:00
Joshua Chen
e1a8db7d91
docs: add TOC heading level options to guide (#7906)
docs: add documentation for TOC heading level options in guide
2022-08-06 21:35:56 +08:00
Joshua Chen
09326bd456
docs: formally document how admonitions can be customized (#7799) 2022-07-20 12:57:12 +02:00
SheetJSDev
ad1d2d2ab1
docs: swizzle react-live with eject (#7739)
docs: swizzle react-live with eject (#7735)
2022-07-08 12:55:39 +08:00
Joshua Chen
1f47151363
docs: mention MDXContent (#7705) 2022-07-01 10:43:06 +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
c03def7d5f
docs: wrap more JSX in mdx-code-block (#7568) 2022-06-05 15:41:06 +08:00
Joshua Chen
6d481f6a29
docs: fix multiple typos (#7561) 2022-06-04 21:22:06 +08:00
JP
f25ee0cbf5
feat(live-codeblock): add support for noInline to interactive code blocks (#7514)
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2022-06-02 10:34:20 +02:00
Joshua Chen
5cf6432e4e
docs: avoid using nested mdx-code-block (#7543)
* docs: avoid using nested mdx-code-block

* fix
2022-06-01 19:32:25 +08:00
Joshua Chen
f40dc31381
docs: multiple documentation elaborations (#7519) 2022-05-28 21:24:01 +08:00
Joshua Chen
ab566ecce3
docs: remove useless front matter (#7518) 2022-05-28 19:07:45 +08:00
Joshua Chen
bac292d84b
docs: document MDXComponents scope (#7503)
* docs: document MDXComponents scope

* address reviews

* add info
2022-05-26 21:50:50 +08:00
Joshua Chen
cd21a31005
test: strengthen internal types (#7488) 2022-05-25 15:38:44 +08:00
Sébastien Lorber
c31d076aed
chore: fix site deployment Crowdin issue (#7326) 2022-05-04 17:48:29 +02:00
Joshua Chen
977ef7121b
docs: add mdx-code-block around tabs; use JS example for magic comments (#7307) 2022-05-04 20:29:09 +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
e73cda87d6
docs: remove extraneous line break tags (#7298) 2022-05-04 11:45:20 +08:00
Joshua Chen
5bed55aeda
refactor(types): JSDoc for docusaurus config fields (#7291) 2022-05-03 13:57:19 +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
0102c2e2ae
docs: wrap code block demos in mdx-code-block (#7262) 2022-04-29 17:09:54 +08:00
Joshua Chen
d2562a4434
refactor: normalize Markdown linkification behavior, elaborate in documentation (#7248)
* refactor: normalize Markdown linkification behavior, elaborate in documentation

* fix broken links

* allow links to be relative to site root

* fix test

* minor doc update

* Update website/docs/guides/markdown-features/markdown-features-links.md

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

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2022-04-29 11:36:39 +08:00
Alexey Pyltsyn
9af35c5b47
refactor: customize code block line highlight color via CSS var (#7176) 2022-04-21 11:19:33 +02:00
Alexey Pyltsyn
ee4c984bc7
feat(theme-classic): code block showLineNumbers (#7007) 2022-04-13 14:42:35 +02:00
Alexey Pyltsyn
d5cfa5b7cf
refactor(theme-classic): fix a few margin inconsistencies (#7129)
* refactor(theme-classic): minor fixes and improvements

* Fixes after review

* Reset spacing for all children inside browser window
2022-04-09 08:27:22 +08:00
Joshua Chen
3cdd038d28
docs: multiple documentation improvements (#7126) 2022-04-07 16:27:28 +08:00
Joshua Chen
4194925da9
docs: add a note about additional languages needing to be Prism component names (#7110) 2022-04-04 10:02:16 +08:00
Joshua Chen
ff96606865
docs: fix some casing inconsistencies (#7081) 2022-03-31 20:23:44 +08:00
Kayce Basques
e31e91ef47
docs: add import React statement in JSX file example (#7050) 2022-03-29 09:30:35 +08:00
Indermohan Singh
2dea99b5c8
docs: remove unnecessary semicolon (#7000)
* docs: remove unnecessary semicolon

The semicolon after the TOCInline component is unnecessary and actually gets rendered on screen.

* ignore prettier

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-25 23:59:13 +08:00
Kayce Basques
395136a731
docs: fix example admonition syntax (#6988)
* Fix example admonition syntax

There was a space between `::: info` should be `:::info` or else Docusaurus does not render it as an admonition.

* kick CI

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-25 08:54:27 +08:00
Joshua Chen
2648ec090e
docs: editorial fixes (#6889) 2022-03-10 13:43:22 +08:00
nate contino
5f1edd5ac8
docs: simplify imported code blocks syntax (#6830)
* refactor: simplify imported code blocks

- Use `language=<lang>` prop instead of "className="language-<lang>" for imported code blocks

I've been using this in my personal projects ([example](https://raw.githubusercontent.com/nathan-contino-mongo/docusaurus-realm/9a2ebb6a43bbbd7b38899fcc86c903dcc1f61283/docs/sdk/kotlin/migrate-from-java-sdk.mdx)) since it is less verbose.
If this interface is somehow less stable than the `className` prop, feel free to close this. But if both will work going forward
we should probably recommend the simpler of the two.

* Update markdown-features-react.mdx
2022-03-04 07:09:16 +08:00
Joshua Chen
c3370be64d
refactor: make MDX export a flat TOC list instead of tree (#6729) 2022-02-23 15:12:04 +01:00
Joshua Chen
b89d93fab5
refactor: recommend using data-theme without html element selector (#6668)
* refactor: recommend using data-theme without html element selector

* simplify site CSS

* refactor
2022-02-14 10:23:42 +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
Joshua Chen
5c447b1ca3
docs: elaborate on Markdown asset linking; document pathname:// (#6404) 2022-01-27 23:16:55 +08:00
Joshua Chen
b8fbf7c530
docs: remove mention that CDN resources are caches cross-domain (#6484) 2022-01-27 19:21:07 +08:00
Pranab Das
f415da1c95
refactor: self-host KaTeX assets (#6429)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-27 11:39:45 +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