3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-11 00:08:52 +02:00
Code Issues Projects Releases Packages Wiki Activity
5801 commits 47 branches 178 tags 993 MiB
Commit graph

40 commits

Author SHA1 Message Date
Tatsunori Uchino
6cc29fac01
 		docs: add heads up for Prettier users () 
* docs: add a note on the use of Prettier for MDX

* docs: add guides for Prettier users migrating to v3

* Update website/docs/guides/markdown-features/markdown-features-react.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

* docs: Update MDX version

* Update website/docs/migration/v3.mdx

* Update v3.mdx

---------

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2023-11-23 13:38:04 -05:00
Sébastien Lorber
7e456ece3c
 		feat(mdx-loader): upgrade to MDX v3 + () 2023-10-26 15:47:11 +02:00
Sébastien Lorber
e9e4635d76
 		docs: "Preparing your site for Docusaurus v3" blog post () 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2023-09-29 13:15:20 +02:00
Sébastien Lorber
f5ae537d3e
 		fix(theme): make warning a first-class admonition, and deprecate caution admonition () 2023-09-15 10:48:21 +02:00
Sébastien Lorber
cc6d9696f0
 		feat(mdx): add siteConfig.markdown.format to configure the default content parser (MDX / CommonMark) () 2023-06-23 18:15:05 +02:00
Sébastien Lorber
7e09ae0c57
 		docs: rewrite some docs for mdx v2 () 
Co-authored-by: Balthasar Hofer <lebalz@outlook.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2023-04-28 15:49:41 +02:00
John Cao
41f1c1e3c2
 		docs: mdx-js is using v2 for next edition () 2023-04-26 17:57:37 +02:00
Sébastien Lorber
bf913aea2a
 		feat: upgrade to MDX v2 () 
Co-authored-by: Armano <armano2@users.noreply.github.com>
 2023-04-21 19:48:57 +02:00
Sébastien Lorber
88b6f5fc68
 		docs: v2 docs should discourage the usage of a lower-case MDX component (will not work in v3) () 2023-03-16 15:23:55 +01:00
Sébastien Lorber
bc00bda5e9
 		chore: revert docs(website): use MDX comments instead of HTML comments () 2023-01-06 17:07:53 +01:00
Sébastien Lorber
9c9d17d6aa
 		docs(website): use MDX comments instead of HTML comments () 2023-01-06 16:22:01 +01:00
Sébastien Lorber
120b99b1f3
 		docs(website): use .mdx extension for every docs () 2022-12-30 15:08:28 +01:00
Waldir Pimenta
6be3beb8c9
 		docs: actually demo the zero-width space workaround in MDX () 2022-11-24 11:00:39 +01:00
Tom Mrazauskas
1f1f898d73
 		docs: delete extra semicolon in MDX and React page () 2022-09-03 14:39:06 -04:00
Joshua Chen
1f47151363
 		docs: mention MDXContent () 2022-07-01 10:43:06 +02:00
Joshua Chen
e12a2efaeb
 		docs: normalize capitalization () 2022-06-15 13:04:33 +08:00
Joshua Chen
6d481f6a29
 		docs: fix multiple typos () 2022-06-04 21:22:06 +08:00
Joshua Chen
5cf6432e4e
 		docs: avoid using nested mdx-code-block () 
* docs: avoid using nested mdx-code-block

* fix
 2022-06-01 19:32:25 +08:00
Joshua Chen
ab566ecce3
 		docs: remove useless front matter () 2022-05-28 19:07:45 +08:00
Joshua Chen
bac292d84b
 		docs: document MDXComponents scope () 
* docs: document MDXComponents scope

* address reviews

* add info
 2022-05-26 21:50:50 +08:00
Joshua Chen
e73cda87d6
 		docs: remove extraneous line break tags () 2022-05-04 11:45:20 +08:00
Joshua Chen
9fd5d62340
 		docs: enhance docs about Markdown TOC and metadata () 
* docs: multiple documentation improvements

* fix

* fix
 2022-04-30 21:30:14 +08:00
Kayce Basques
e31e91ef47
 		docs: add import React statement in JSX file example () 2022-03-29 09:30:35 +08:00
nate contino
5f1edd5ac8
 		docs: simplify imported code blocks syntax () 
* 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
c1e3801ee7
 		fix(cli): allow passing a list of file names to write-heading-ids () 2022-01-29 12:21:15 +08:00
Joshua Chen
8140560332
 		docs: multiple doc improvements () 2022-01-23 15:49:28 +08:00
Joshua Chen
ba352271e7
 		fix(website): wrap details in mdx-code-block () 2022-01-10 20:35:39 +08:00
Joshua Chen
c7da6f5dd3
 		docs: document MD and JSX interoperability issues () 2022-01-10 20:05:33 +08:00
Joshua Chen
c45281a581
 		feat(theme-classic): usable CodeBlock outside markdown () 2021-12-29 17:17:09 +01:00
Joshua Chen
6a772828c5
 		docs: add default value for BrowserWindow URL field () 
* docs: fix BrowserWindow URL field

* fix
 2021-12-28 15:19:23 +08:00
Joshua Chen
73ee356949
 		docs: audit grammar issues () 
* docs: audit grammar mistakes

* fix code block language

* revert change

* let's get another
 2021-12-27 19:34:04 +08:00
Joshua Chen
0fc7adfba9
 		docs: document global variables in MDX scope () 
* Adding a note for how to access frontMatter within pages

* Move documentation

Co-authored-by: cd rubin <github@earthling.za.net>
 2021-11-07 23:16:04 +08:00
Alexey Pyltsyn
19302c4913
 		docs: clarify MDX version used () 
* docs: clarify MDX version used

* Update MDX Playground link
 2021-09-17 21:27:00 +03:00
Sébastien Lorber
dc4664b489
 		feat: details/summary theme / MDX component () 
* Details component

* polish arrow animation

* fix text selection bug

* fix some edge cases + polish

* example of overriding baseClassName

* Move Details component to theme-common

* make component work even when JS is disabled or failed to load

* update arrow transform

* Details component: better handling of no-JS fallback mode: avoid delaying arrow navigation when JS (see review)

* prefix css vars with --docusaurus

* improve css arrow styling

* slightly change details/summary design

* better md doc + include quotes and details in doc
 2021-07-27 18:45:12 +02:00
Pranab Das
7b2d45a439
 		docs(v2): Elaboration of raw-loader in markdown react component () 
* docs(v2): Elaboration of raw-loader in React component

* Add prettier ignore for a blocks to avoid unintended semicolon
 2021-07-23 10:31:38 +02:00
Sébastien Lorber
c63295a253
 		docs(v2): wrap mdx usage in mdx-code-block () 2021-06-18 17:59:51 +02:00
Joshua Chen
3d95a3e6b1
 		docs(v2): add documentation about importing code files () 
* Add documentation about importing code files

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

* Add warning about breaking API change

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

* Update website/docs/guides/markdown-features/markdown-features-react.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-06-15 18:38:28 +02:00
Joshua Chen
02b512c2cf
 		docs(v2): add documentation about importing markdown () 
* Add documentation about importing markdown

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

* Update website/docs/guides/markdown-features/markdown-features-react.mdx

* Run prettier

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

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-06-15 12:20:53 +02:00
Sébastien Lorber
6811a72e72
 		feat(v2): ability to "escape" JSX in MDX files as code blocks () 
* 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
Sébastien Lorber
d99d53a236
 		docs(v2): Reorganize/split the guides doc sections () 
* docs reorg

* refactor docs/markdown features section

* fix broken links after docs refactor
 2020-12-30 17:03:25 +01:00