Commit graph

801 commits

Author SHA1 Message Date
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
Alexey Pyltsyn
ecbe0b26c5
refactor(theme-{classic,common}): refactor ColorModeToggle + useColorMode() hook (#6930)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2022-03-18 15:28:35 +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
68aaf9201f
feat(core): allow plugin lifecycles to return relative paths (#6921)
* feat(core): resolve plugin lifecycles returning relative paths

* fix typo

* fix tests

* revert

* rename path -> entryPath
2022-03-16 20:47:15 +08:00
Joshua Chen
8d1c1954c1
refactor(content-blog): clean up type definitions; in-code documentation (#6922)
* refactor(content-blog): clean up type definitions; in-code documentation

* add doc
2022-03-16 19:36:57 +08:00
Joshua Chen
ff1b7168ba
chore: upgrade dependencies (#6916) 2022-03-15 13:16:21 +08:00
Joshua Chen
2648ec090e
docs: editorial fixes (#6889) 2022-03-10 13:43:22 +08:00
Begula
63caeb6073
docs(cli): add info about development on github codespaces (#6883)
* docs: add info about development on github codespaces

* docs: move from installation to cli

* docs: fix grammar

* Update cli.md

* add word

* Update cli.md

* Update cli.md

* format

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-10 11:22:21 +08:00
Joshua Chen
2a7120cc02
docs: mention configureWebpack devServer return value (#6881) 2022-03-09 20:23:38 +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
Nayan Patel
1c91d2f20e
docs: fix broken links (#6817)
* Fix a broken showcase GitHub URL

* Seems like this site is no longer Open Source?

* Seems like this site is no longer open source?

* Fix as previous link leaded to a 404

* Replaces the 404 error of previous page.

Not sure if this is the correct link to be placed there.

* Fixes 404 error ;)
2022-03-03 07:02:57 +08:00
Joshua Chen
6cbc58943e
feat: allow blog authors email (#6783) 2022-03-02 16:28:17 +01:00
Joshua Chen
7ec44bb32c
refactor(theme-classic): replace color mode toggle with button; remove switchConfig (#6771)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-03-02 15:57:17 +01:00
David Stotijn
2e3eec2d08
fix: consistently use max-width: 996px in media queries (#6815)
* fix: consistently use `max-width: 996px` in media queries

Follow `docusaurus-theme-classic` and use `996px` as the cutoff
between desktop and mobile screen width.

* revert example changes

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-02 19:43:44 +08:00
Joshua Chen
a4dc03edee
chore: upgrade dependencies (#6789)
* chore: upgrade dependencies

* upgrade setup-node
2022-03-01 10:40:34 +08:00
Ariful Alam
95ab08285b
docs: make GitHub actions explanation aligned with the code (#6776)
* fix(website): update github actions files

* revert some changes

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-02-27 16:27:23 +08:00
Joshua Chen
908ad52025
docs: add basic documentation about client modules (#6772) 2022-02-26 18:25:19 +08:00
Joshua Chen
39b66d82ef
feat(core): rework swizzle CLI (#6243)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-25 14:13:15 +01:00
Joshua Chen
a70514205d
feat(create): new --package-manager option; interactive package manager selection (#6750) 2022-02-24 11:50:37 +01:00
Alexey Pyltsyn
26d223dbeb
feat(create): better detection of package manager preference (#6679)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-23 16:22:40 +01: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
9562a5d203
refactor: remove deprecated Webpack utils & validation escape hatch (#6740) 2022-02-23 11:40:58 +01:00
Sébastien Lorber
a6f53aa9d2
refactor(theme-classic): bias again search metadata toward Algolia DocSearch (#6707) 2022-02-17 14:24:31 +01:00
Sébastien Lorber
12aae9a086
docs: add doc for generated-index keyword/image metadata (#6708) 2022-02-17 14:24:13 +01:00
Alexey Pyltsyn
0f1f35b678
docs(website): fix video responsiveness (#6709) 2022-02-17 14:22:36 +01:00
Dmitry Vinnik
1551407a9b
docs: add deep dive video for Docusaurus (#6687) 2022-02-17 12:03:26 +01:00
Sébastien Lorber
49361e2ae9
docs(website): search doc typo searchParameters (#6704) 2022-02-17 11:57:30 +01:00
Alexey Pyltsyn
53c2c118c4
feat(search-algolia): allow disabling search page and configuring path (#6692) 2022-02-16 19:07:01 +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
94532dfd26
docs: fix bad anchor link syntax (#6683) 2022-02-15 11:24:50 +08:00
Joshua Chen
d460d48dfc
docs: mention that all official themes are TypeScript-covered (#6675)
* docs: mention that all official themes are TypeScript-covered

* revert...

* kick
2022-02-14 23:33:37 +08:00
Joshua Chen
c27695ab5c
docs: mention about blog date in front matter (#6673)
* docs: mention about blog date in front matter

* fix
2022-02-14 15:42:37 +08: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
b16b394eb6
feat(create): allow specifying a git clone strategy (#6610)
* feat(create): allow specifying a git clone strategy

* Update index.ts
2022-02-10 11:15:06 +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
a350a8a130
docs: fix bad anchor link syntax (#6611) 2022-02-05 14:52:19 +08:00
Joshua Chen
3fd99ad8d4
feat(content-blog): allow customizing blog archive component through option (#6603)
* feat(content-blog): allow customizing blog archive component through option

* fix
2022-02-04 18:56:09 +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
Everardo J. Barojas M
caa9d281c3
docs: improve Github Actions example jobs (#6591)
* docs: Improve docs on deploy.yml gh action

* docs: Improve docs on test-deploy.yml gh action

* docs: improve docs on delpoy.yml and test-deploy.yml gh action on next version docs

* docs: rm unneeded lines

* edits

Co-authored-by: Everardo J Barojas M <everardo@prescrypto.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-02-03 20:42:19 +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
2553f1fb5a
refactor: improve internal typing (#6507)
* refactor: improve internal typing

* fix

* fix test
2022-01-29 22:58:40 +08:00
Gaurish
8bdecf107c
docs: add Cloudflare pages deployment guide (#6501)
* Docs: Add Cloudflare pages deployment guide

* minor tweaks

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-29 13:27:34 +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
f2b1c8e80e
docs: mention how env vars can be read (#6499) 2022-01-29 11:34:30 +08:00
Tamal Web
ade486d079
docs: mention where to find the sitemap (#6492)
* Added the sitemap url

So that users know where to locate their sitemaps

* Update plugin-sitemap.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-28 17:11:09 +08:00
Joshua Chen
556f59b193
fix(utils): do not resolve Markdown paths with @site prefix (#6489) 2022-01-28 10:10:39 +08:00