]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
docs: Regen docs helper
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 31 May 2022 08:23:20 +0000 (10:23 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 31 May 2022 08:23:20 +0000 (10:23 +0200)
docs/data/docs.json

index f573df44b9ffaf565f8cbeba4077ae0234078ef2..7fc8e2f0bfe8864ccc6ba354c782d2ed48727044 100644 (file)
           "taskList": true
         }
       },
-      "blackFriday": {
-        "smartypants": true,
-        "smartypantsQuotesNBSP": false,
-        "angledQuotes": false,
-        "fractions": true,
-        "hrefTargetBlank": false,
-        "nofollowLinks": false,
-        "noreferrerLinks": false,
-        "smartDashes": true,
-        "latexDashes": true,
-        "taskLists": true,
-        "plainIDAnchors": true,
-        "extensions": null,
-        "extensionsMask": null,
-        "skipHTML": false,
-        "footnoteAnchorPrefix": "",
-        "footnoteReturnLinkContents": ""
-      },
       "asciidocExt": {
         "backend": "html5",
         "extensions": [],
           "jsx"
         ]
       },
+      {
+        "mainType": "text",
+        "subType": "markdown",
+        "delimiter": ".",
+        "firstSuffix": {
+          "suffix": "md",
+          "fullSuffix": ".md"
+        },
+        "type": "text/markdown",
+        "string": "text/markdown",
+        "suffixes": [
+          "md",
+          "markdown"
+        ]
+      },
       {
         "mainType": "text",
         "subType": "plain",
         "permalinkable": false,
         "weight": 0
       },
+      {
+        "mediaType": "text/markdown",
+        "name": "MARKDOWN",
+        "path": "",
+        "baseName": "index",
+        "rel": "alternate",
+        "protocol": "",
+        "isPlainText": true,
+        "isHTML": false,
+        "noUgly": false,
+        "notAlternative": false,
+        "permalinkable": false,
+        "weight": 0
+      },
       {
         "mediaType": "text/plain",
         "name": "ROBOTS",
     "funcs": {
       "cast": {
         "ToFloat": {
-          "Description": "ToFloat converts the given value to a float.",
+          "Description": "ToFloat converts v to a float.",
           "Args": [
             "v"
           ],
           ]
         },
         "ToInt": {
-          "Description": "ToInt converts the given value to an int.",
+          "Description": "ToInt converts v to an int.",
           "Args": [
             "v"
           ],
           ]
         },
         "ToString": {
-          "Description": "ToString converts the given value to a string.",
+          "Description": "ToString converts v to a string.",
           "Args": [
             "v"
           ],
       },
       "crypto": {
         "FNV32a": {
-          "Description": "",
-          "Args": null,
+          "Description": "FNV32a hashes using fnv32a algorithm",
+          "Args": [
+            "in"
+          ],
           "Aliases": null,
-          "Examples": null
+          "Examples": [
+            [
+              "{{ crypto.FNV32a \"Hugo Rocks!!\" }}",
+              "1515779328"
+            ]
+          ]
         },
         "HMAC": {
           "Description": "HMAC returns a cryptographic hash that uses a key to sign a message.",
       },
       "fmt": {
         "Errorf": {
-          "Description": "Errorf formats according to a format specifier and logs an ERROR.\nIt returns an empty string.",
+          "Description": "Errorf formats args according to a format specifier and logs an ERROR.\nIt returns an empty string.",
           "Args": [
             "format",
-            "a"
+            "args"
           ],
           "Aliases": [
             "errorf"
           ]
         },
         "Erroridf": {
-          "Description": "Erroridf formats according to a format specifier and logs an ERROR and\nan information text that the error with the given ID can be suppressed in config.\nIt returns an empty string.",
+          "Description": "Erroridf formats args according to a format specifier and logs an ERROR and\nan information text that the error with the given ID can be suppressed in config.\nIt returns an empty string.",
           "Args": [
             "id",
             "format",
-            "a"
+            "args"
           ],
           "Aliases": [
             "erroridf"
           ]
         },
         "Print": {
-          "Description": "Print returns string representation of the passed arguments.",
+          "Description": "Print returns a string representation args.",
           "Args": [
-            "a"
+            "args"
           ],
           "Aliases": [
             "print"
           ]
         },
         "Printf": {
-          "Description": "Printf returns a formatted string representation of the passed arguments.",
+          "Description": "Printf returns a formatted string representation of args.",
           "Args": [
             "format",
-            "a"
+            "args"
           ],
           "Aliases": [
             "printf"
           ]
         },
         "Println": {
-          "Description": "Println returns string representation of the passed arguments ending with a newline.",
+          "Description": "Println returns string representation of args  ending with a newline.",
           "Args": [
-            "a"
+            "args"
           ],
           "Aliases": [
             "println"
           ]
         },
         "Warnf": {
-          "Description": "Warnf formats according to a format specifier and logs a WARNING.\nIt returns an empty string.",
+          "Description": "Warnf formats args according to a format specifier and logs a WARNING.\nIt returns an empty string.",
           "Args": [
             "format",
-            "a"
+            "args"
           ],
           "Aliases": [
             "warnf"
       },
       "math": {
         "Add": {
-          "Description": "Add adds two numbers.",
+          "Description": "Add adds the two addends n1 and n2.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": [
             "add"
           ]
         },
         "Ceil": {
-          "Description": "Ceil returns the least integer value greater than or equal to x.",
+          "Description": "Ceil returns the least integer value greater than or equal to n.",
           "Args": [
-            "x"
+            "n"
           ],
           "Aliases": null,
           "Examples": [
           "Examples": null
         },
         "Div": {
-          "Description": "Div divides two numbers.",
+          "Description": "Div divides n1 by n2.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": [
             "div"
           ]
         },
         "Floor": {
-          "Description": "Floor returns the greatest integer value less than or equal to x.",
+          "Description": "Floor returns the greatest integer value less than or equal to n.",
           "Args": [
-            "x"
+            "n"
           ],
           "Aliases": null,
           "Examples": [
           ]
         },
         "Log": {
-          "Description": "Log returns the natural logarithm of a number.",
+          "Description": "Log returns the natural logarithm of the number n.",
           "Args": [
-            "a"
+            "n"
           ],
           "Aliases": null,
           "Examples": [
           ]
         },
         "Max": {
-          "Description": "Max returns the greater of two numbers.",
+          "Description": "Max returns the greater of the two numbers n1 or n2.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": null,
           "Examples": [
           ]
         },
         "Min": {
-          "Description": "Min returns the smaller of two numbers.",
+          "Description": "Min returns the smaller of two numbers n1 or n2.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": null,
           "Examples": [
           ]
         },
         "Mod": {
-          "Description": "Mod returns a % b.",
+          "Description": "Mod returns n1 % n2.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": [
             "mod"
           ]
         },
         "ModBool": {
-          "Description": "ModBool returns the boolean of a % b.  If a % b == 0, return true.",
+          "Description": "ModBool returns the boolean of n1 % n2.  If n1 % n2 == 0, return true.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": [
             "modBool"
           ]
         },
         "Mul": {
-          "Description": "Mul multiplies two numbers.",
+          "Description": "Mul multiplies the two numbers n1 and n2.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": [
             "mul"
           ]
         },
         "Pow": {
-          "Description": "Pow returns a raised to the power of b.",
+          "Description": "Pow returns n1 raised to the power of n2.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": [
             "pow"
           ]
         },
         "Round": {
-          "Description": "Round returns the nearest integer, rounding half away from zero.",
+          "Description": "Round returns the integer nearest to n, rounding half away from zero.",
           "Args": [
-            "x"
+            "n"
           ],
           "Aliases": null,
           "Examples": [
           ]
         },
         "Sqrt": {
-          "Description": "Sqrt returns the square root of a number.",
+          "Description": "Sqrt returns the square root of the number n.",
           "Args": [
-            "a"
+            "n"
           ],
           "Aliases": null,
           "Examples": [
           ]
         },
         "Sub": {
-          "Description": "Sub subtracts two numbers.",
+          "Description": "Sub subtracts n2 from n1.",
           "Args": [
-            "a",
-            "b"
+            "n1",
+            "n2"
           ],
           "Aliases": [
             "sub"
           "Aliases": null,
           "Examples": null
         },
+        "Copy": {
+          "Description": "",
+          "Args": null,
+          "Aliases": null,
+          "Examples": null
+        },
         "ExecuteAsTemplate": {
           "Description": "",
           "Args": null,
       },
       "safe": {
         "CSS": {
-          "Description": "CSS returns a given string as html/template CSS content.",
+          "Description": "CSS returns the string s as html/template CSS content.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "safeCSS"
           ]
         },
         "HTML": {
-          "Description": "HTML returns a given string as html/template HTML content.",
+          "Description": "HTML returns the string s as html/template HTML content.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "safeHTML"
           ]
         },
         "HTMLAttr": {
-          "Description": "HTMLAttr returns a given string as html/template HTMLAttr content.",
+          "Description": "HTMLAttr returns the string s as html/template HTMLAttr content.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "safeHTMLAttr"
         "JS": {
           "Description": "JS returns the given string as a html/template JS content.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "safeJS"
         "JSStr": {
           "Description": "JSStr returns the given string as a html/template JSStr content.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "safeJSStr"
           "Examples": []
         },
         "SanitizeURL": {
-          "Description": "SanitizeURL returns a given string as html/template URL content.",
+          "Description": "SanitizeURL returns the string s as html/template URL content.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "sanitizeURL",
           "Examples": []
         },
         "URL": {
-          "Description": "URL returns a given string as html/template URL content.",
+          "Description": "URL returns the string s as html/template URL content.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "safeURL"
           ]
         },
         "FirstUpper": {
-          "Description": "FirstUpper returns a string with the first character as upper case.",
+          "Description": "FirstUpper converts s making  the first character upper case.",
           "Args": [
             "s"
           ],
           "Examples": null
         },
         "Repeat": {
-          "Description": "Repeat returns a new string consisting of count copies of the string s.",
+          "Description": "Repeat returns a new string consisting of n copies of the string s.",
           "Args": [
             "n",
             "s"
           ]
         },
         "Trim": {
-          "Description": "Trim returns a string with all leading and trailing characters defined\ncontained in cutset removed.",
+          "Description": "Trim returns converts the strings s removing all leading and trailing characters defined\ncontained.",
           "Args": [
             "s",
             "cutset"
           ]
         },
         "Format": {
-          "Description": "Format converts the textual representation of the datetime string into\nthe other form or returns it of the time.Time value. These are formatted\nwith the layout string",
+          "Description": "Format converts the textual representation of the datetime string in v into\ntime.Time if needed and formats it with the given layout.",
           "Args": [
             "layout",
             "v"
           ]
         },
         "Now": {
-          "Description": "Now returns the current local time.",
+          "Description": "Now returns the current local time or `clock` time",
           "Args": null,
           "Aliases": [
             "now"
           "Examples": []
         },
         "ParseDuration": {
-          "Description": "ParseDuration parses a duration string.\nA duration string is a possibly signed sequence of\ndecimal numbers, each with optional fraction and a unit suffix,\nsuch as \"300ms\", \"-1.5h\" or \"2h45m\".\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\nSee https://golang.org/pkg/time/#ParseDuration",
+          "Description": "ParseDuration parses the duration string s.\nA duration string is a possibly signed sequence of\ndecimal numbers, each with optional fraction and a unit suffix,\nsuch as \"300ms\", \"-1.5h\" or \"2h45m\".\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\nSee https://golang.org/pkg/time/#ParseDuration",
           "Args": [
-            "in"
+            "s"
           ],
           "Aliases": null,
           "Examples": [
           ]
         },
         "HTMLUnescape": {
-          "Description": "HTMLUnescape returns a copy of with HTML escape requences converted to plain\ntext.",
+          "Description": "HTMLUnescape returns a copy of with HTML escape requences converted to plain\ntext.",
           "Args": [
             "s"
           ],
           "Examples": null
         },
         "Markdownify": {
-          "Description": "Markdownify renders a given input from Markdown to HTML.",
+          "Description": "Markdownify renders s from Markdown to HTML.",
           "Args": [
             "s"
           ],
       },
       "urls": {
         "AbsLangURL": {
-          "Description": "AbsLangURL takes a given string and converts it to an absolute URL according\nto a page's position in the project directory structure and the current\nlanguage.",
+          "Description": "AbsLangURL the string s and converts it to an absolute URL according\nto a page's position in the project directory structure and the current\nlanguage.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "absLangURL"
           "Examples": []
         },
         "AbsURL": {
-          "Description": "AbsURL takes a given string and converts it to an absolute URL.",
+          "Description": "AbsURL takes the string s and converts it to an absolute URL.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "absURL"
           "Examples": []
         },
         "Anchorize": {
-          "Description": "Anchorize creates sanitized anchor names that are compatible with Blackfriday.",
+          "Description": "Anchorize creates sanitized anchor name version of the string s that is compatible\nwith how your configured markdown renderer does it.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "anchorize"
           "Examples": null
         },
         "Ref": {
-          "Description": "Ref returns the absolute URL path to a given content item.",
+          "Description": "Ref returns the absolute URL path to a given content item from Page p.",
           "Args": [
-            "in",
+            "p",
             "args"
           ],
           "Aliases": [
           "Examples": []
         },
         "RelLangURL": {
-          "Description": "RelLangURL takes a given string and prepends the relative path according to a\npage's position in the project directory structure and the current language.",
+          "Description": "RelLangURL takes the string s and prepends the relative path according to a\npage's position in the project directory structure and the current language.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "relLangURL"
           "Examples": []
         },
         "RelRef": {
-          "Description": "RelRef returns the relative URL path to a given content item.",
+          "Description": "RelRef returns the relative URL path to a given content item from Page p.",
           "Args": [
-            "in",
+            "p",
             "args"
           ],
           "Aliases": [
           "Examples": []
         },
         "RelURL": {
-          "Description": "RelURL takes a given string and prepends the relative path according to a\npage's position in the project directory structure.",
+          "Description": "RelURL takes the string s and prepends the relative path according to a\npage's position in the project directory structure.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "relURL"
           "Examples": []
         },
         "URLize": {
-          "Description": "URLize returns the given argument formatted as URL.",
+          "Description": "URLize returns the the strings s formatted as an URL.",
           "Args": [
-            "a"
+            "s"
           ],
           "Aliases": [
             "urlize"