3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-28 00:17:14 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: audit grammar issues (#6203)

Browse source 
* docs: audit grammar mistakes

* fix code block language

* revert change

* let's get another
This commit is contained in:
Joshua Chen 2021-12-27 19:34:04 +08:00 • committed by GitHub
parent 3195e7feed
commit 73ee356949
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
56 changed files with 432 additions and 383 deletions
Download patch file Download diff file Expand all files Collapse all files

8
website/docs/guides/markdown-features/markdown-features-assets.mdx
View file

@ -20,7 +20,7 @@ Let's imagine the following file structure:
## Images {#images}
You can display images in three different ways: Markdown syntax, JSX require or ES imports syntax.
You can display images in three different ways: Markdown syntax, CJS require, or ES imports syntax.
Display images using simple Markdown syntax:
@ -57,7 +57,7 @@ If you are using [@docusaurus/plugin-ideal-image](../../api/plugins/plugin-ideal
## Files {#files}
In the same way, you can link to existing assets by requiring them and using the returned url in videos, links etc.
In the same way, you can link to existing assets by requiring them and using the returned url in videos, links, etc.
```mdx
# My Markdown page
@ -95,7 +95,7 @@ import DocusaurusSvg from '@site/static/img/docusaurus.svg';
<DocusaurusSvg />
This can be useful, if you want to alter the part of the SVG image via CSS. For example, you can change one of the SVG colors based on the current theme.
This can be useful if you want to alter the part of the SVG image via CSS. For example, you can change one of the SVG colors based on the current theme.
```jsx
import DocusaurusSvg from './docusaurus.svg';
@ -154,5 +154,5 @@ If a Markdown link or image has an absolute path, the path will be seen as a fil
Docusaurus will try to look for it in both `static/img/docusaurus.png` and `public/img/docusaurus.png`. The link will then be converted to a `require` call instead of staying as a URL. This is desirable in two regards:
1. You don't have to worry about base URL, which Docusaurus will take care of when serving the asset;
1. You don't have to worry about the base URL, which Docusaurus will take care of when serving the asset;
2. The image enters Webpack's build pipeline and its name will be appended by a hash, which enables browsers to aggressively cache the image and improves your site's performance.