Sébastien Lorber
14586895ae
docs: improve sidebar items custom props docs ( #8888 )
2023-04-13 12:24:27 +02:00
Sébastien Lorber
361dfda2fd
docs: remove problematic mdx2 anchor id docs for MDX 2 migration ( #8788 )
2023-03-17 18:10:04 +01:00
Sébastien Lorber
9c920c531b
docs: prepare docs for MDX 2 ( #8782 )
2023-03-16 17:02:38 +01:00
Davide Donadio
5c271f5622
feat(content-docs): add support for sidebar item category/link descriptions in generated index page ( #8236 )
...
Co-authored-by: Davide Donadio <davide.donadio@it.clara.net>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2023-03-16 10:14:42 +01:00
Sébastien Lorber
120b99b1f3
docs(website): use .mdx extension for every docs ( #8490 )
2022-12-30 15:08:28 +01:00
Marco Stroppel
024474a7b9
docs: fix link to docs only mode ( #8453 )
...
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-12-22 15:33:55 +01:00
Anna
4b11c57f7e
docs: autogenerated page comment does not matching dirName in examples ( #8364 )
2022-11-23 17:37:22 +01:00
Sébastien Lorber
c811d6249e
feat(theme): ability to use <DocCardList> without items prop, on any doc page ( #8008 )
2022-08-26 17:42:59 +02:00
Joshua Chen
8e3e89d9ff
docs: add link from every category index page to the guide page ( #7665 )
2022-06-23 13:46:59 +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
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
Steven Hicks
9ead309809
docs: add clarity to versioning behavior ( #7327 )
2022-05-05 00:15:50 +08: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
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
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
Andrew Lyons
ec109737e9
docs: explain more clearly the purpose of a ref sidebar type ( #7159 )
2022-04-12 15:59:41 +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
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
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
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
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
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
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
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
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
Joseph
8ce3cee400
feat(theme-classic): auto-collapse sibling categories in doc sidebar ( #3811 )
...
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2022-01-20 16:38:16 +01:00
Joshua Chen
45f1b819b5
feat(content-docs): displayed_sidebar front matter ( #5782 )
2022-01-19 16:00:42 +01:00
Morooka Kotaro
4aaa48759d
docs: remove typo bracket ( #6327 )
...
* docs: remove typo bracket
* fix in latest version
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-13 15:13:50 +08:00
Nick Schonning
02a233a221
chore: minor typo cleanup ( #6324 )
...
* chore: minor typo cleanup
* fix tests
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-13 14:36:53 +08:00
Joshua Chen
06a8cdcb0f
docs: elaborate on doc versioning ( #6280 )
...
* docs: elaborate on doc versioning
* Complete
* fix
2022-01-07 14:28:48 +08:00
Joshua Chen
4872decb42
docs: normalize CodeBlock highlighting ( #6223 )
2021-12-30 10:51:00 +08:00
Joshua Chen
6a772828c5
docs: add default value for BrowserWindow URL field ( #6207 )
...
* docs: fix BrowserWindow URL field
* fix
2021-12-28 15:19:23 +08:00
Joshua Chen
73ee356949
docs: audit grammar issues ( #6203 )
...
* docs: audit grammar mistakes
* fix code block language
* revert change
* let's get another
2021-12-27 19:34:04 +08:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders ( #6142 )
2021-12-21 14:56:29 +01:00
Himanshu
c0a99786b3
docs: elaborate on "docs-only" and "blog-only" ( #6131 )
...
* rephrased documentation
* Rewording
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-20 09:29:43 +08:00
Joshua Chen
18cb13d6cc
docs: refactor docs sidebar doc ( #6130 )
...
* docs: refactor docs sidebar doc
* Edits
2021-12-19 19:08:59 +08:00
Joshua Chen
7db4884853
refactor(website): make deploy preview open next version docs by default ( #6120 )
...
* refactor(website): make deploy preview open next version docs by default
* Fix links
2021-12-17 11:00:12 +08: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
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
