---
title: "@farmfe/plugin-yaml"
locale: "en"
version: "1.x"
canonicalUrl: "https://farmfe.org/docs/1.x/plugins/official-plugins/yaml"
publicationStatus: "prerelease"
---

<a id="farmfeplugin-yaml"></a>
# @farmfe/plugin-yaml


Inspired By [@rollup/plugin-yaml](<https://www.npmjs.com/package/@rollup/plugin-yaml>)


🍣 A Farm plugin which Converts YAML files to ES6 modules.


<a id="installation"></a>
## Installation


**npm**

```javascript
npm install @farmfe/plugin-yaml
```


**yarn**

```javascript
yarn add @farmfe/plugin-yaml
```


**pnpm**

```javascript
pnpm add @farmfe/plugin-yaml
```



<a id="usage"></a>
## Usage


farm.config.ts


```typescript
import { defineConfig } from '@farmfe/core';

export default defineConfig({
  plugins: [
    [
      '@farmfe/plugin-yaml',
      {
        documentMode: 'single' | 'multi', // default single
        include: Regex, // default None,
        exclude: Regex, // default None
      },
    ],
  ],
});
```


notice:


include or exclude is Regex not glob For example ` **/01.yaml ` is not illegal。What is right is like ` ".*\\/01.yaml" `