3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-11-09 20:07:15 +01:00
Code Issues Projects Releases Packages Wiki Activity
5,972 commits 48 branches 181 tags 1 GiB
Commit graph

150 commits

Author SHA1 Message Date
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
f40dc31381
 		docs: multiple documentation elaborations () 2022-05-28 21:24:01 +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
cd21a31005
 		test: strengthen internal types () 2022-05-25 15:38:44 +08:00
Sébastien Lorber
c31d076aed
 		chore: fix site deployment Crowdin issue () 2022-05-04 17:48:29 +02:00
Joshua Chen
977ef7121b
 		docs: add mdx-code-block around tabs; use JS example for magic comments () 2022-05-04 20:29:09 +08:00
Joshua Chen
51815c12c9
 		feat(theme-classic): extensible code block magic comment system () 2022-05-04 12:31:13 +02:00
Joshua Chen
e73cda87d6
 		docs: remove extraneous line break tags () 2022-05-04 11:45:20 +08:00
Joshua Chen
5bed55aeda
 		refactor(types): JSDoc for docusaurus config fields () 2022-05-03 13:57:19 +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
Joshua Chen
0102c2e2ae
 		docs: wrap code block demos in mdx-code-block () 2022-04-29 17:09:54 +08:00
Joshua Chen
d2562a4434
 		refactor: normalize Markdown linkification behavior, elaborate in documentation () 
* 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 () 2022-04-21 11:19:33 +02:00
Alexey Pyltsyn
ee4c984bc7
 		feat(theme-classic): code block showLineNumbers () 2022-04-13 14:42:35 +02:00
Alexey Pyltsyn
d5cfa5b7cf
 		refactor(theme-classic): fix a few margin inconsistencies () 
* 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 () 2022-04-07 16:27:28 +08:00
Joshua Chen
4194925da9
 		docs: add a note about additional languages needing to be Prism component names () 2022-04-04 10:02:16 +08:00
Joshua Chen
ff96606865
 		docs: fix some casing inconsistencies () 2022-03-31 20:23:44 +08:00
Kayce Basques
e31e91ef47
 		docs: add import React statement in JSX file example () 2022-03-29 09:30:35 +08:00
Indermohan Singh
2dea99b5c8
 		docs: remove unnecessary semicolon () 
* 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 () 
* 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 () 2022-03-10 13:43:22 +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
c3370be64d
 		refactor: make MDX export a flat TOC list instead of tree () 2022-02-23 15:12:04 +01:00
Joshua Chen
b89d93fab5
 		refactor: recommend using data-theme without html element selector () 
* 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 () 2022-01-29 12:21:15 +08:00
Joshua Chen
5c447b1ca3
 		docs: elaborate on Markdown asset linking; document pathname:// () 2022-01-27 23:16:55 +08:00
Joshua Chen
b8fbf7c530
 		docs: remove mention that CDN resources are caches cross-domain () 2022-01-27 19:21:07 +08:00
Pranab Das
f415da1c95
 		refactor: self-host KaTeX assets () 
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 () 
* 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
Joshua Chen
8140560332
 		docs: multiple doc improvements () 2022-01-23 15:49:28 +08:00
Joshua Chen
3d7ba337c2
 		refactor(mdx-loader): use vfile.path to access Markdown file path () 2022-01-22 22:28:50 +08:00
Joshua Chen
e40cafccd5
 		chore: enable stylelint standard config () 
* chore: enable stylelint standard config

* remove empty line

* fix
 2022-01-22 21:26:35 +08:00
Joshua Chen
6c0da3ee4b
 		refactor: clean up TODO comments () 2022-01-19 12:10:50 +08:00
Nick Schonning
9f9a96dc80
 		chore: upgrade lint-staged and globs () 2022-01-15 16:33:09 +08:00
Pranab Das
99dbf1a121
 		docs: minor fix in the sample config for ESM () 
The line `return config;` was left by mistake I guess. The function is already returning the `config` object.
 2022-01-14 19:24:55 +08:00
Pranab Das
4ebb1ca8c8
 		chore: upgrade rehype-katex with ESM support, update docs () 
* chore: upgrade rehype-katex to latest version with ESM support and update the docs

* Update documentation to reflect ESM upgrade is currently optional

* rewording

* final tweaks

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2022-01-14 09:06:10 +08:00
Joshua Chen
217b62682d
 		feat(mdx-loader): preserve hash in image src; support GH themed images () 
* feat(mdx-loader): preserve hash in image src; support GH themed images

* more refactor
 2022-01-13 10:22:48 +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
4872decb42
 		docs: normalize CodeBlock highlighting () 2021-12-30 10:51:00 +08:00
Joshua Chen
c45281a581
 		feat(theme-classic): usable CodeBlock outside markdown () 2021-12-29 17:17:09 +01:00
Joshua Chen
96dbb8e7ef
 		feat(website): improve prism themes () 
* feat(website): modify Prism dark theme

* update

* Use vsDark

* update crowdin config

* fix light theme as well

* revert comment changes
 2021-12-29 21:25:01 +08:00
Joshua Chen
0fa091a0c2
 		docs: use BrowserWindow for Markdown demos () 2021-12-29 13:49:09 +08: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
4f2330a824
 		docs: recommend highlighting with comments than number range () 
* docs: recommend highlighting with comments than number range

* quick fix
 2021-12-28 10:55:24 +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
8cd593379c
 		docs: fix react live scope button color in dark mode () 2021-12-25 16:50:14 +08:00
Joshua Chen
3889e89380
 		fix(theme-classic): make React elements in pre render correctly () 
* fix(theme-classic): make React elements in pre render correctly

* Properly fix

* Use MDX

* Add docs

* Better comment

* Update code-block-tests.mdx
 2021-12-25 15:27:29 +08:00