5aaa33fc61
feat: add --no-minify flag to docusaurus start ( #7452 )
...
* feat: Adding --no-minify flag to start
* Undoing the changes to old docs
Co-authored-by: Lane Goolsby <lanegoolsby@rocketmortgage.com>
2022-05-20 12:50:17 +08:00
a4c54aba45
docs: add Azure SWA as deployment option ( #7407 )
...
I've linked to the dev.to article (which is a timestamped stable version) - to be consistent with other deployment snippets.
The dev.to article references [this GitHub repo](https://github.com/fearlessly-dev/swa-demo-docusaurus ) and this[#30DaysOfSWA](https://www.azurestaticwebapps.dev/blog/build-with-docusaurus ) site which was the inspiration for writing this article. The repo contains the code for the demo, and its README is the canonical source for the article, in case relevant.
2022-05-14 19:57:43 +08:00
fa10d1b1a4
fix(website): use react-lite-youtube-embed for lazy YouTube video ( #7390 )
...
* fix(website): use react-lite-youtube-embed for lazy YouTube video
* fix(website): use react-lite-youtube-embed for lazy YouTube video
* fix(website): use react-lite-youtube-embed for lazy YouTube video
* Update multiple-sidebars.md
* Update installation.md
* refactor intro
* rename file back
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-05-12 10:30:59 +08:00
a0b060759d
docs: fix translation config example ( #7396 )
2022-05-11 14:35:19 +08:00
6e10a48059
fix(content-docs): restore functionality when a category only has index page ( #7385 )
...
* fix(content-docs): restore functionality when a category only has index page
* use this internally
2022-05-10 14:50:43 +08:00
f29bb73300
fix(core): make error boundary fallback a component instead of a callback ( #7368 )
2022-05-07 22:35:57 +08:00
c892492a12
docs(website): fix code block Crowdin issue ( #7345 )
2022-05-05 15:35:43 +02:00
0cc4fa82c1
docs: add page for create-docusaurus API documentation ( #7343 )
...
* docs: add page for create-docusaurus API documentation
* update
2022-05-05 19:36:51 +08:00
9ead309809
docs: add clarity to versioning behavior ( #7327 )
2022-05-05 00:15:50 +08:00
c31d076aed
chore: fix site deployment Crowdin issue ( #7326 )
2022-05-04 17:48:29 +02:00
977ef7121b
docs: add mdx-code-block around tabs; use JS example for magic comments ( #7307 )
2022-05-04 20:29:09 +08:00
51815c12c9
feat(theme-classic): extensible code block magic comment system ( #7178 )
2022-05-04 12:31:13 +02:00
785fed723f
refactor(theme-classic): move all sidebar-related config under themeConfig.docs.sidebar ( #7277 )
2022-05-04 12:08:19 +02:00
7a3894e664
docs: update docs for logger, add API docs to website ( #7305 )
...
* docs: update docs for logger, add API docs to website
* fix broken image
2022-05-04 17:59:47 +08:00
e73cda87d6
docs: remove extraneous line break tags ( #7298 )
2022-05-04 11:45:20 +08:00
5bed55aeda
refactor(types): JSDoc for docusaurus config fields ( #7291 )
2022-05-03 13:57:19 +08:00
594d8f357c
docs: add a paragraph about SSR as an optimization technique ( #7284 )
2022-05-02 14:23:42 +08:00
9fd5d62340
docs: enhance docs about Markdown TOC and metadata ( #7278 )
...
* docs: multiple documentation improvements
* fix
* fix
2022-04-30 21:30:14 +08:00
afc72480ab
refactor(eslint-plugin): migrate to TS-ESLint infrastructure ( #7276 )
...
* refactor(eslint-plugin): migrate to TS-ESLint infrastructure
* fix lock
2022-04-30 17:57:57 +08:00
355a22907d
docs: specify Node version requirement to a minor ( #7271 )
...
* Update installation.md
I believe the current version of Docusaurus requires node 16. With 14 I get:
```
import {program} from 'commander';
^^^^^^^
SyntaxError: The requested module 'commander' does not provide an export named 'program'
at ModuleJob._instantiate (internal/modules/esm/module_job.js:92:21)
at async ModuleJob.run (internal/modules/esm/module_job.js:107:20)
at async Loader.import (internal/modules/esm/loader.js:179:24)
```
* Update installation.md
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-30 09:12:37 +08:00
3b1170eb44
feat: Docusaurus ESLint plugin to enforce best Docusaurus practices ( #7206 )
...
* feat: add eslint plugin
* refactor
* add tests
* fixups!
* fix(no-dynamic-i18n-messages): make translate() recognize template literals
* refactor: rename rule no-dynamic-i18n-messages --> string-literal-i18n-messages
* feat: add ignoreStrings option and refactor
* docs: migrate docs to /docs/api/plugins
* docs: fix anchor links in README.md
* fix: add some ignored strings
* docs: update eslint-plugin docs
* fix: update README link
* docs: various updates
- Reorder sidebar entries
- Fix title size
- Use Markdown file paths
- Simplify relative links
* address reviews
* wording polish
* add npmignore
* fix all internal warnings
* doc improvements
* fix test
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-30 00:04:25 +08:00
ae788c536f
feat(core): rework client modules lifecycles, officially make API public ( #6732 )
2022-04-29 15:11:20 +02:00
0102c2e2ae
docs: wrap code block demos in mdx-code-block ( #7262 )
2022-04-29 17:09:54 +08:00
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
b747143982
docs: update gtag docs to reflect what a GA4 tag looks like ( #7252 )
2022-04-28 09:05:25 +08:00
67faa686e8
refactor: semantic markup improvement, fix validation warnings ( #7244 )
...
* refactor: semantic markup improvement, fix validation warnings
* change section/article a bit
2022-04-26 20:15:45 +08:00
743738d8c6
docs: add documentation about pluralization ( #7236 )
2022-04-24 11:23:28 +08:00
9af35c5b47
refactor: customize code block line highlight color via CSS var ( #7176 )
2022-04-21 11:19:33 +02:00
84d04ed6ed
feat(theme-classic): new 'html' type navbar item ( #7058 )
...
* feat(theme-classic): allow using html in dropdown items
* Fix tests
* Introduce HTML type for navbar item
* Update packages/docusaurus-theme-classic/src/theme/NavbarItem/HtmlNavbarItem.tsx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-15 18:58:15 +08:00
5fb0a2e274
feat(content-docs): draft docs excluded from build & sidebars ( #6457 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-13 18:02:05 +02:00
ee4c984bc7
feat(theme-classic): code block showLineNumbers ( #7007 )
2022-04-13 14:42:35 +02:00
ec109737e9
docs: explain more clearly the purpose of a ref sidebar type ( #7159 )
2022-04-12 15:59:41 +08:00
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
7941a46be3
feat: allow setting calendar for i18n date formatting ( #6430 )
...
* feat: allow setting calendar for i18n date formatting
* fix TS
* add test
2022-04-08 22:34:34 +08:00
171927342f
feat(core): fail-safe global data fetching ( #7083 )
2022-04-08 11:08:22 +02:00
bfbc78e52a
feat: allow using pure HTML as label in navbar links ( #7079 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-04-07 12:33:52 +02:00
3cdd038d28
docs: multiple documentation improvements ( #7126 )
2022-04-07 16:27:28 +08:00
c669c103f9
refactor(website): minor fixes and improvements ( #7119 )
...
* refactor(website): minor fixes and improvements
* Some fixes
* Round all the corners in browser window
* Add rounded bottom corners to browser window
2022-04-07 08:33:52 +08:00
49424f5057
docs: correct plugin example filename ( #7026 )
...
* Correect Wrong file name
The file name inside the my-plugin folder is index.js .
* Update plugins.md
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-07 08:17:06 +08:00
103ea04661
feat(sitemap): add ignorePatterns option ( #6979 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-06 15:44:07 +02:00
4194925da9
docs: add a note about additional languages needing to be Prism component names ( #7110 )
2022-04-04 10:02:16 +08:00
ff96606865
docs: fix some casing inconsistencies ( #7081 )
2022-03-31 20:23:44 +08:00
24c205a835
refactor: replace non-prop interface with type; allow plugin lifecycles to have sync type ( #7080 )
...
* refactor: replace non-prop interface with type; allow plugin lifecycles to have sync type
* fix
2022-03-31 19:16:07 +08:00
77662260f8
refactor(core): refactor routes generation logic ( #7054 )
...
* refactor(core): refactor routes generation logic
* fixes
2022-03-29 16:37:29 +08:00
e31e91ef47
docs: add import React statement in JSX file example ( #7050 )
2022-03-29 09:30:35 +08:00
5fb09a2946
refactor(core): reorganize files ( #7042 )
...
* refactor(core): reorganize files
* fix types
2022-03-28 21:49:37 +08:00
2bcac29cd4
refactor(content-docs): deduplicate types, JSDoc for some APIs ( #7027 )
...
* refactor(content-docs): deduplicate types, JSDoc for some APIs
* little refactor
2022-03-27 12:57:15 +08:00
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
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
b5ceead3b2
feat(content-docs): autogenerate category with linked doc metadata as fallback ( #6859 )
2022-03-25 15:23:11 +01:00
Lane Goolsby