summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoe Mooring <joe.mooring@veriphor.com>2022-06-04 13:40:32 -0700
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-06-06 09:36:16 +0200
commit953f215f32ada15700cdd7d65471f55d72833c5c (patch)
tree34dd54c7158bd26554304bd504d612460e0567af /docs
parent8e2fd55923a4da38eb2ddda51dc1b96943be0c56 (diff)
tpl/path: Add path.BaseName function
Closes #9973
Diffstat (limited to 'docs')
-rw-r--r--docs/content/en/functions/path.Base.md2
-rw-r--r--docs/content/en/functions/path.BaseName.md24
-rw-r--r--docs/content/en/functions/path.Clean.md3
-rw-r--r--docs/content/en/functions/path.Dir.md2
-rw-r--r--docs/content/en/functions/path.Ext.md2
-rw-r--r--docs/content/en/functions/path.Join.md2
-rw-r--r--docs/content/en/functions/path.Split.md2
7 files changed, 31 insertions, 6 deletions
diff --git a/docs/content/en/functions/path.Base.md b/docs/content/en/functions/path.Base.md
index c44518a72..a6bfc2bd5 100644
--- a/docs/content/en/functions/path.Base.md
+++ b/docs/content/en/functions/path.Base.md
@@ -12,7 +12,7 @@ keywords: [path, base]
signature: ["path.Base PATH"]
workson: []
hugoversion: "0.40"
-relatedfuncs: [path.Dir, path.Ext, path.Split]
+relatedfuncs: [path.BaseName, path.Clean, path.Dir, path.Ext, path.Join, path.Split]
deprecated: false
---
diff --git a/docs/content/en/functions/path.BaseName.md b/docs/content/en/functions/path.BaseName.md
new file mode 100644
index 000000000..6a5b9f0a0
--- /dev/null
+++ b/docs/content/en/functions/path.BaseName.md
@@ -0,0 +1,24 @@
+---
+title: path.BaseName
+description: BaseName returns the last element of a path, removing the extension if present.
+date: 2022-06-04
+categories: [functions]
+menu:
+ docs:
+ parent: "functions"
+keywords: [path, base]
+signature: ["path.BaseName PATH"]
+relatedfuncs: [path.Base, path.Clean, path.Dir, path.Ext, path.Join, path.Split]
+deprecated: false
+---
+
+If `PATH` is empty, `.` is returned.
+
+**Note:** On Windows, `PATH` is converted to slash (`/`) separators.
+
+```go-html-template
+{{ path.BaseName "a/news.html" }} → "news"
+{{ path.BaseName "news.html" }} → "news"
+{{ path.BaseName "a/b/c" }} → "c"
+{{ path.BaseName "/x/y/z/" }} → "z"
+```
diff --git a/docs/content/en/functions/path.Clean.md b/docs/content/en/functions/path.Clean.md
index 03ffbd836..852de65fd 100644
--- a/docs/content/en/functions/path.Clean.md
+++ b/docs/content/en/functions/path.Clean.md
@@ -8,8 +8,9 @@ categories: [functions]
menu:
docs:
parent: "functions"
-keywords: [path]
+keywords: [path, clean]
signature: ["path.Clean PATH"]
+relatedfuncs: [path.Base, path.BaseName, path.Dir, path.Ext, path.Join, path.Split]
---
`path.Clean` replaces path separators with slashes (`/`) and removes extraneous separators, including trailing separators.
diff --git a/docs/content/en/functions/path.Dir.md b/docs/content/en/functions/path.Dir.md
index 851a3dc83..161a0daa8 100644
--- a/docs/content/en/functions/path.Dir.md
+++ b/docs/content/en/functions/path.Dir.md
@@ -12,7 +12,7 @@ keywords: [path, dir]
signature: ["path.Dir PATH"]
workson: []
hugoversion: "0.40"
-relatedfuncs: [path.Base, path.Ext, path.Split]
+relatedfuncs: [path.Base, path.BaseName, path.Clean, path.Ext, path.Join, path.Split]
deprecated: false
---
diff --git a/docs/content/en/functions/path.Ext.md b/docs/content/en/functions/path.Ext.md
index 73db7ab38..8c6fe907c 100644
--- a/docs/content/en/functions/path.Ext.md
+++ b/docs/content/en/functions/path.Ext.md
@@ -12,7 +12,7 @@ keywords: [path, ext, extension]
signature: ["path.Ext PATH"]
workson: []
hugoversion: "0.40"
-relatedfuncs: [path.Base, path.Dir, path.Split]
+relatedfuncs: [path.Base, path.BaseName, path.Clean, path.Dir, path.Join, path.Split]
deprecated: false
---
diff --git a/docs/content/en/functions/path.Join.md b/docs/content/en/functions/path.Join.md
index 96ce86322..579e8667e 100644
--- a/docs/content/en/functions/path.Join.md
+++ b/docs/content/en/functions/path.Join.md
@@ -12,7 +12,7 @@ keywords: [path, join]
signature: ["path.Join ELEMENT..."]
workson: []
hugoversion: "0.39"
-relatedfuncs: [path.Split]
+relatedfuncs: [path.Base, path.BaseName, path.Clean, path.Dir, path.Ext, path.Split]
deprecated: false
---
diff --git a/docs/content/en/functions/path.Split.md b/docs/content/en/functions/path.Split.md
index 9a09fbe4a..7737b77d3 100644
--- a/docs/content/en/functions/path.Split.md
+++ b/docs/content/en/functions/path.Split.md
@@ -12,7 +12,7 @@ keywords: [path, split]
signature: ["path.Split PATH"]
workson: []
hugoversion: "0.39"
-relatedfuncs: [path.Split]
+relatedfuncs: [path.Base, path.BaseName, path.Clean, path.Dir, path.Ext, path.Join]
deprecated: false
---