Steven Hicks
9ead309809
docs: add clarity to versioning behavior ( #7327 )
2022-05-05 00:15:50 +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
785fed723f
refactor(theme-classic): move all sidebar-related config under themeConfig.docs.sidebar ( #7277 )
2022-05-04 12:08:19 +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
Andrew Lyons
ec109737e9
docs: explain more clearly the purpose of a ref sidebar type ( #7159 )
2022-04-12 15:59:41 +08: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
Leedom
b842197ac6
docs: consistently use sidebars.js filename ( #7016 )
...
* modify sidebar.js to sidebars.js in installation.md
* modify sidebar.js to sidebars.js
Co-authored-by: leedom <leedom@jinlanzuan.com>
2022-03-27 09:55:12 +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
Joshua Chen
b5ceead3b2
feat(content-docs): autogenerate category with linked doc metadata as fallback ( #6859 )
2022-03-25 15:23:11 +01: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
Sébastien Lorber
74f653dd82
refactor(theme-{classic,common}): change how site/page/search metadata is handled ( #6925 )
2022-03-18 18:53:00 +01:00
Kayce Basques
284649c7c8
docs: clarify the usage of slug ( #6926 )
...
* Clarify the usage of slug
As a new user it was unclear whether setting `slug` would change the URL relative to the root directory or relative to the docs directory. The example I added should make that clear without needing to test out the functionality in a Docusaurus instance (which is what I had to do).
* editorial changes
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-17 07:54:18 +08:00
Joshua Chen
2648ec090e
docs: editorial fixes ( #6889 )
2022-03-10 13:43:22 +08:00
tae
2e163a9ec4
feat(content-docs): allow custom props through _category_.json ( #6780 )
...
* feat(content-docs): allow custom props through _category_.json
* refactor
* documentation
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-05 18:52:36 +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
Sébastien Lorber
12aae9a086
docs: add doc for generated-index keyword/image metadata ( #6708 )
2022-02-17 14:24:13 +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
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
TheCatLady
665d164351
feat(content-docs): add custom props front matter ( #6619 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-02-09 17:04:07 +01:00
BigDataWriter
bd05b74808
docs: improve wording of using Markdown file paths ( #6633 )
...
* Update docs-markdown-features.mdx
* Author meant to recommend the use of full paths rather than relative paths: Technical edit
* Revised intro to naturally introduce the benefits of this recommendation: Style edit
* Update website/docs/guides/docs/docs-markdown-features.mdx
* Update website/docs/guides/docs/docs-markdown-features.mdx
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-02-08 11:12:38 +08:00
Joshua Chen
0c4dc00443
feat(content-docs): allow omitting enclosing array consistently for category shorthand ( #6602 )
...
* feat(content-docs): allow omitting enclosing array consistently for category shorthand
* update snapshot
* fix doc
2022-02-04 11:16:08 +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
Jody Heavener
6ec0db4722
feat(content-docs): sidebar item type "html" for rendering pure markup ( #6519 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-02 18:38:35 +01:00
Joshua Chen
3573b5e4a9
fix(content-docs): render category with no subitems as a normal link ( #6495 )
2022-02-02 14:45:00 +01: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
3c58d7f027
feat(content-docs): allow explicitly disabling index page for generated category ( #6452 )
...
* feat(content-docs): allow explicitly disabling index page for generated category
* docs
* add test
2022-01-27 23:14:07 +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
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
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
Joshua Chen
711a6fe3d0
docs: document embedding generated index in doc page ( #6453 )
...
* docs: document embedding generated index in doc page
* fix
2022-01-23 20:04:34 +08:00
Joshua Chen
01676329e1
docs: split sidebar documentation into sections ( #6450 )
...
* docs: split sidebar documentation into sections
* set slugs
* fix links
2022-01-23 17:50:48 +08:00
Joshua Chen
8140560332
docs: multiple doc improvements ( #6449 )
2022-01-23 15:49:28 +08:00
Joshua Chen
3d7ba337c2
refactor(mdx-loader): use vfile.path to access Markdown file path ( #6443 )
2022-01-22 22:28:50 +08:00
Joshua Chen
e40cafccd5
chore: enable stylelint standard config ( #6442 )
...
* chore: enable stylelint standard config
* remove empty line
* fix
2022-01-22 21:26:35 +08:00
