From ad8027340e413dadcdd51359a02c10f50e2bc368 Mon Sep 17 00:00:00 2001
From: Daniel Roe <daniel@roe.dev>
Date: Mon, 28 Feb 2022 18:36:56 +0000
Subject: [PATCH] docs: add `.nuxtignore` docs (#3440)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* docs: add `.nuxtignore` docs

* docs: fix link syntax

* style: lint

* style: add lang

* Update 17.nuxtignore.md

Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>
---
 .../2.directory-structure/17.nuxtignore.md    | 31 +++++++++++++++++++
 .../{17.package.md => 18.package.md}          |  0
 .../{18.tsconfig.md => 19.tsconfig.md}        |  0
 3 files changed, 31 insertions(+)
 create mode 100644 docs/content/3.docs/2.directory-structure/17.nuxtignore.md
 rename docs/content/3.docs/2.directory-structure/{17.package.md => 18.package.md} (100%)
 rename docs/content/3.docs/2.directory-structure/{18.tsconfig.md => 19.tsconfig.md} (100%)

diff --git a/docs/content/3.docs/2.directory-structure/17.nuxtignore.md b/docs/content/3.docs/2.directory-structure/17.nuxtignore.md
new file mode 100644
index 0000000000..d180049a7b
--- /dev/null
+++ b/docs/content/3.docs/2.directory-structure/17.nuxtignore.md
@@ -0,0 +1,31 @@
+---
+icon: IconFile
+title: .nuxtignore
+head.title: .nuxtignore file
+---
+
+# Nuxt ignore file
+
+You can use a `.nuxtignore` file to let Nuxt ignore `layout`, `pages`, `components`, `composables` and `middleware` files in your project’s root directory (`rootDir`) during the build phase. The `.nuxtignore` file is subject to the same specification as `.gitignore` and `.eslintignore` files, in which each line is a glob pattern indicating which files should be ignored.a
+
+**Note**: You can also configure [`ignoreOptions`](/docs/directory-structure/nuxt.config#ignoreoptions), [`ignorePrefix`](/docs/directory-structure/nuxt.config#ignoreprefix) and [`ignore`](/docs/directory-structure/nuxt.config#ignore) in your `nuxt.config` file.
+
+## Example
+
+```bash [.nuxtignore]
+# ignore layout foo.vue
+layouts/foo.vue
+# ignore layout files whose name ends with -ignore.vue
+layouts/*-ignore.vue
+
+# ignore page bar.vue
+pages/bar.vue
+# ignore page inside ignore folder
+pages/ignore/*.vue
+
+# ignore route middleware files under foo folder except foo/bar.js
+middleware/foo/*.js
+!middleware/foo/bar.js
+```
+
+> More details about the spec are in [gitignore doc](https://git-scm.com/docs/gitignore)
diff --git a/docs/content/3.docs/2.directory-structure/17.package.md b/docs/content/3.docs/2.directory-structure/18.package.md
similarity index 100%
rename from docs/content/3.docs/2.directory-structure/17.package.md
rename to docs/content/3.docs/2.directory-structure/18.package.md
diff --git a/docs/content/3.docs/2.directory-structure/18.tsconfig.md b/docs/content/3.docs/2.directory-structure/19.tsconfig.md
similarity index 100%
rename from docs/content/3.docs/2.directory-structure/18.tsconfig.md
rename to docs/content/3.docs/2.directory-structure/19.tsconfig.md