Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/NumFmt.md')
-rw-r--r--docs/content/en/functions/NumFmt.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/content/en/functions/NumFmt.md b/docs/content/en/functions/NumFmt.md
new file mode 100644
index 000000000..1bc07abd5
--- /dev/null
+++ b/docs/content/en/functions/NumFmt.md
@@ -0,0 +1,38 @@
+---
+title: lang.NumFmt
+description: "Formats a number with a given precision using the requested `negative`, `decimal`, and `grouping` options. The `options` parameter is a string consisting of `<negative> <decimal> <grouping>`."
+godocref: ""
+workson: []
+date: 2017-02-01
+publishdate: 2017-02-01
+lastmod: 2017-08-21
+categories: [functions]
+keywords: [numbers]
+menu:
+ docs:
+ parent: "functions"
+toc: false
+signature: ["lang.NumFmt PRECISION NUMBER [OPTIONS [DELIMITER]]"]
+workson: []
+hugoversion:
+relatedfuncs: []
+deprecated: false
+draft: false
+aliases: []
+comments:
+---
+
+The default options value is `- . ,`. The default delimiter within the options
+value is a space. If you need to use a space as one of the options, set a
+custom delimiter.
+
+Numbers greater than or equal to 5 are rounded up. For example, if precision is set to `0`, `1.5` becomes `2`, and `1.4` becomes `1`.
+
+```
+{{ lang.NumFmt 2 12345.6789 }} → 12,345.68
+{{ lang.NumFmt 2 12345.6789 "- , ." }} → 12.345,68
+{{ lang.NumFmt 0 -12345.6789 "- . ," }} → -12,346
+{{ lang.NumFmt 6 -12345.6789 "- ." }} → -12345.678900
+{{ lang.NumFmt 6 -12345.6789 "-|.| " "|" }} → -1 2345.678900
+{{ -98765.4321 | lang.NumFmt 2 }} → -98,765.43
+```