summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/os/FileExists.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/os/FileExists.md')
-rw-r--r--docs/content/en/functions/os/FileExists.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/content/en/functions/os/FileExists.md b/docs/content/en/functions/os/FileExists.md
new file mode 100644
index 000000000..b8104a066
--- /dev/null
+++ b/docs/content/en/functions/os/FileExists.md
@@ -0,0 +1,41 @@
+---
+title: os.FileExists
+description: Reports whether the file or directory exists.
+categories: []
+keywords: []
+action:
+ aliases: [fileExists]
+ related:
+ - functions/os/Getenv
+ - functions/os/ReadDir
+ - functions/os/ReadFile
+ - functions/os/Stat
+ returnType: bool
+ signatures: [os.FileExists PATH]
+aliases: [/functions/fileexists]
+---
+
+The `os.FileExists` function attempts to resolve the path relative to the root of your project directory. If a matching file or directory is not found, it will attempt to resolve the path relative to the [`contentDir`](/getting-started/configuration#contentdir). A leading path separator (`/`) is optional.
+
+With this directory structure:
+
+```text
+content/
+├── about.md
+├── contact.md
+└── news/
+ ├── article-1.md
+ └── article-2.md
+```
+
+The function returns these values:
+
+```go-html-template
+{{ fileExists "content" }} → true
+{{ fileExists "content/news" }} → true
+{{ fileExists "content/news/article-1" }} → false
+{{ fileExists "content/news/article-1.md" }} → true
+{{ fileExists "news" }} → true
+{{ fileExists "news/article-1" }} → false
+{{ fileExists "news/article-1.md" }} → true
+```