docs: Create path.Clean documentation
authorJoe Mooring <joe.mooring@veriphor.com>
Sat, 9 Oct 2021 18:36:57 +0000 (11:36 -0700)
committerGitHub <noreply@github.com>
Sat, 9 Oct 2021 18:36:57 +0000 (20:36 +0200)
Related to #9005

docs/content/en/functions/path.Clean.md [new file with mode: 0644]

diff --git a/docs/content/en/functions/path.Clean.md b/docs/content/en/functions/path.Clean.md
new file mode 100644 (file)
index 0000000..03ffbd8
--- /dev/null
@@ -0,0 +1,26 @@
+---
+title: path.Clean
+description: Replaces path separators with slashes (`/`) and removes extraneous separators.
+date: 2021-10-08
+# publishdate: 2018-11-28
+# lastmod: 2018-11-28
+categories: [functions]
+menu:
+  docs:
+    parent: "functions"
+keywords: [path]
+signature: ["path.Clean PATH"]
+---
+
+`path.Clean` replaces path separators with slashes (`/`) and removes extraneous separators, including trailing separators.
+
+```
+{{ path.Clean "foo//bar" }} → "foo/bar"
+{{ path.Clean "/foo/bar/" }} → "/foo/bar"
+```
+
+On a Windows system, if `.File.Path` is `foo\bar.md`, then:
+
+```
+{{ path.Clean .File.Path }} → "foo/bar.md"
+```