静态资源

静态资源是会被直接复制到构建输出的非代码文件。 它们包括图像、样式表、图标、字体等。

By default, you are suggested to put these assets in the static folder. Every file you put into that directory will be copied into the root of the generated build folder with the directory hierarchy preserved. 举个例子， if you add a file named sun.jpg to the static folder, it will be copied to build/sun.jpg.

这意味着：

• for site baseUrl: '/', the image /static/img/docusaurus.png will be served at /img/docusaurus.png.
• for site baseUrl: '/subpath/', the image /static/img/docusaurus.png will be served at /subpath/img/docusaurus.png.

You can customize the static directory sources in docusaurus.config.js. For example, we can add public as another possible path:

docusaurus.config.js

module.exports = {
  title: 'My site',
  staticDirectories: ['public', 'static'],
  // ...
};

Now, all files in public as well as static will be copied to the build output.

Referencing your static asset

In JSX

In JSX, you can reference assets from the static folder in your code using absolute URLs, but this is not ideal because changing the site baseUrl will break those links. For the image <img src="/img/docusaurus.png" /> served at https://example.com/test, the browser will try to resolve it from the URL root, i.e. as https://example.com/img/docusaurus.png, which will fail because it's actually served at https://example.com/test/img/docusaurus.png.

You can import() or require() the static asset (recommended), or use the useBaseUrl utility function: both prepend the baseUrl to paths for you.

示例：

MyComponent.js

import DocusaurusImageUrl from '@site/static/img/docusaurus.png';

<img src={DocusaurusImageUrl} />;

MyComponent.js

<img src={require('@site/static/img/docusaurus.png').default} />

MyComponent.js

import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('/img/docusaurus.png')} />;

你也可以导入 SVG 文件：它会被自动转换为 React 组件。

MyComponent.js

import DocusaurusLogoWithKeytar from '@site/static/img/docusaurus_keytar.svg';

<DocusaurusLogoWithKeytar title="Docusaurus Logo" className="logo" />;

In Markdown

In Markdown, you can stick to using absolute paths when writing links or images in Markdown syntax because Docusaurus handles them as require calls instead of URLs when parsing the Markdown. See Markdown static assets.

You write a link like this: [Download this document](/files/note.docx)

Docusaurus changes that to: <a href={require('static/files/note.docx')}>Download this document</a>

use Markdown syntax

Docusaurus 只会解析用 Markdown 语法的链接。 If your asset references are using the JSX tag <a> / <img>, nothing will be done.

In CSS

In CSS, the url() function is commonly used to reference assets like fonts and images. 要引用静态资源，请使用绝对路径：

@font-face {
  font-family: 'Caroline';
  src: url('/font/Caroline.otf');
}

The static/font/Caroline.otf asset will be loaded by the bundler.

important takeaway

One important takeaway: never hardcode your base URL! The base URL is considered an implementation detail and should be easily changeable. 所有路径，即使看起来像 URL 路径，实际上都是文件路径。

如果你觉得用 URL 的心智模型更容易理解，这里是我们的经验法则：

• Pretend you have a base URL like /test/ when writing JSX so you don't use an absolute URL path like src="/img/thumbnail.png" but instead require the asset.
• Pretend it's / when writing Markdown or CSS so you always use absolute paths without the base URL.

Caveats

有几点需要留意：

• By default, none of the files in the static folder will be post-processed, hashed, or minified.
  • However, as we've demonstrated above, we are usually able to convert them to require calls for you so they do get processed. 这有助于积极缓存，从而保证更好的用户体验。
• 使用硬编码的绝对路径引用的文件，无法在编译时被检测到缺失，从而导致 404 错误。
• By default, GitHub Pages runs published files through Jekyll. Since Jekyll will discard any files that begin with _, it is recommended that you disable Jekyll by adding an empty file named .nojekyll file to your static directory if you are using GitHub pages for hosting.