Merge commit '6dbde8d731f221b027c0c60b772ba82dad759943'

Fixes #3709
2024-05-11 05:54:58 +00:00 · 2017-07-18 10:33:58 +02:00
parent deccc54004 6dbde8d731
commit 4c220c4ac2
579 changed files with 20511 additions and 16227 deletions
--- a/docs/content/functions/math.md
+++ b/docs/content/functions/math.md
@@ -0,0 +1,67 @@
+---
+title: Math
+description: Hugo provides six mathematical operators in templates.
+godocref:
+date: 2017-02-01
+publishdate: 2017-02-01
+lastmod: 2017-02-01
+#tags: [math, operators]
+categories: [functions]
+menu:
+  docs:
+    parent: "functions"
+toc:
+signature: []
+workson: []
+hugoversion:
+relatedfuncs: []
+deprecated: false
+draft: false
+aliases: []
+---
+
+There are 6 basic mathematical operators that can be used in Hugo templates:
+
+| Function | Description              | Example                       |
+| -------- | ------------------------ | ----------------------------- |
+| `add`    | Adds two integers.       | `{{add 1 2}}` &rarr; 3        |
+| `div`    | Divides two integers.    | `{{div 6 3}}` &rarr; 2        |
+| `mod`    | Modulus of two integers. | `{{mod 15 3}}` &rarr; 0       |
+| `modBool`| Boolean of modulus of two integers. Evaluates to `true` if = 0. | `{{modBool 15 3}}` &rarr; true |
+| `mul`    | Multiplies two integers. | `{{mul 2 3}}` &rarr; 6        |
+| `sub`    | Subtracts two integers.  | `{{sub 3 2}}` &rarr; 1        |
+
+## Use `add` with Strings
+
+You can also use the `add` function with strings. You may like this functionality in many use cases, including creating new variables by combining page- or site-level variables with other strings.
+
+For example, social media sharing with [Twitter Cards][cards] requires the following `meta` link in your site's `<head>` to display Twitter's ["Summary Card with Large Image"][twtsummary]:
+
+```html
+<meta name="twitter:image" content="http://yoursite.com/images/my-twitter-image.jpg">
+```
+
+Let's assume you have an `image` field in the front matter of each of your content files:
+
+```yaml
+---
+title: My Post
+image: my-post-image.jpg
+---
+```
+
+You can then concatenate the `image` value (string) with the path to your `images` directory in `static` and leverage a URL-related templating function for increased flexibility:
+
+{{% code file="partials/head/twitter-card.html" %}}
+```html
+{{$socialimage := add "images/" .Params.image}}
+<meta name="twitter:image" content="{{ $socialimage | absURL }}">
+```
+{{% /code %}}
+
+{{% note %}}
+The `add` example above makes use of the [`absURL` function](/functions/absurl/). `absURL` and its relative companion `relURL` is the recommended way to construct URLs in Hugo.
+{{% /note %}}
+
+[cards]: https://dev.twitter.com/cards/overview
+[twtsummary]: https://dev.twitter.com/cards/types/summary-large-image