github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Regenerate the docs helper

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2018-11-02 12:56:19 +01:00
parent 61f210dd7a
commit 486bc46a52
1 changed files with 340 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

423
docs/data/docs.json
View file

@ -81,6 +81,13 @@
"bnf" "bnf"
] ]
}, },
{
"Name": "Ballerina",
"Aliases": [
"bal",
"ballerina"
]
},
{ {
"Name": "Base Makefile", "Name": "Base Makefile",
"Aliases": [ "Aliases": [
@ -208,6 +215,13 @@
"capnp" "capnp"
] ]
}, },
{
"Name": "Cassandra CQL",
"Aliases": [
"cassandra",
"cql"
]
},
{ {
"Name": "Ceylon", "Name": "Ceylon",
"Aliases": [ "Aliases": [
@ -525,6 +539,7 @@
"Aliases": [ "Aliases": [
"cfg", "cfg",
"dosini", "dosini",
"gitconfig",
"inf", "inf",
"ini" "ini"
] ]
@ -576,6 +591,12 @@
"julia" "julia"
] ]
}, },
{
"Name": "Jungle",
"Aliases": [
"jungle"
]
},
{ {
"Name": "Kotlin", "Name": "Kotlin",
"Aliases": [ "Aliases": [
@ -651,6 +672,13 @@
"modula2" "modula2"
] ]
}, },
{
"Name": "MonkeyC",
"Aliases": [
"mc",
"monkeyc"
]
},
{ {
"Name": "MorrowindScript", "Name": "MorrowindScript",
"Aliases": [ "Aliases": [
@ -736,6 +764,20 @@
"octave" "octave"
] ]
}, },
{
"Name": "OpenSCAD",
"Aliases": [
"openscad",
"scad"
]
},
{
"Name": "Org Mode",
"Aliases": [
"org",
"orgmode"
]
},
{ {
"Name": "PHP", "Name": "PHP",
"Aliases": [ "Aliases": [
@ -940,6 +982,13 @@
"sql" "sql"
] ]
}, },
{
"Name": "SYSTEMD",
"Aliases": [
"service",
"systemd"
]
},
{ {
"Name": "Sass", "Name": "Sass",
"Aliases": [ "Aliases": [
@ -1076,6 +1125,13 @@
"thrift" "thrift"
] ]
}, },
{
"Name": "TradingView",
"Aliases": [
"tradingview",
"tv"
]
},
{ {
"Name": "Transact-SQL", "Name": "Transact-SQL",
"Aliases": [ "Aliases": [
@ -1232,90 +1288,148 @@
"types": [ "types": [
{ {
"type": "application/javascript", "type": "application/javascript",
"string": "application/javascript+js", "string": "application/javascript",
"mainType": "application", "mainType": "application",
"subType": "javascript", "subType": "javascript",
"suffix": "js", "delimiter": ".",
"delimiter": "." "suffixes": [
"js"
]
}, },
{ {
"type": "application/json", "type": "application/json",
"string": "application/json+json", "string": "application/json",
"mainType": "application", "mainType": "application",
"subType": "json", "subType": "json",
"suffix": "json", "delimiter": ".",
"delimiter": "." "suffixes": [
"json"
]
}, },
{ {
"type": "application/rss", "type": "application/octet-stream",
"string": "application/octet-stream",
"mainType": "application",
"subType": "octet-stream",
"delimiter": "",
"suffixes": null
},
{
"type": "application/rss+xml",
"string": "application/rss+xml", "string": "application/rss+xml",
"mainType": "application", "mainType": "application",
"subType": "rss", "subType": "rss",
"suffix": "xml", "delimiter": ".",
"delimiter": "." "suffixes": [
"xml"
]
}, },
{ {
"type": "application/xml", "type": "application/xml",
"string": "application/xml+xml", "string": "application/xml",
"mainType": "application", "mainType": "application",
"subType": "xml", "subType": "xml",
"suffix": "xml", "delimiter": ".",
"delimiter": "." "suffixes": [
"xml"
]
},
{
"type": "image/svg+xml",
"string": "image/svg+xml",
"mainType": "image",
"subType": "svg",
"delimiter": ".",
"suffixes": [
"svg"
]
}, },
{ {
"type": "text/calendar", "type": "text/calendar",
"string": "text/calendar+ics", "string": "text/calendar",
"mainType": "text", "mainType": "text",
"subType": "calendar", "subType": "calendar",
"suffix": "ics", "delimiter": ".",
"delimiter": "." "suffixes": [
"ics"
]
}, },
{ {
"type": "text/css", "type": "text/css",
"string": "text/css+css", "string": "text/css",
"mainType": "text", "mainType": "text",
"subType": "css", "subType": "css",
"suffix": "css", "delimiter": ".",
"delimiter": "." "suffixes": [
"css"
]
}, },
{ {
"type": "text/csv", "type": "text/csv",
"string": "text/csv+csv", "string": "text/csv",
"mainType": "text", "mainType": "text",
"subType": "csv", "subType": "csv",
"suffix": "csv", "delimiter": ".",
"delimiter": "." "suffixes": [
"csv"
]
}, },
{ {
"type": "text/html", "type": "text/html",
"string": "text/html+html", "string": "text/html",
"mainType": "text", "mainType": "text",
"subType": "html", "subType": "html",
"suffix": "html", "delimiter": ".",
"delimiter": "." "suffixes": [
"html"
]
}, },
{ {
"type": "text/plain", "type": "text/plain",
"string": "text/plain+txt", "string": "text/plain",
"mainType": "text", "mainType": "text",
"subType": "plain", "subType": "plain",
"suffix": "txt", "delimiter": ".",
"delimiter": "." "suffixes": [
"txt"
]
},
{
"type": "text/x-sass",
"string": "text/x-sass",
"mainType": "text",
"subType": "x-sass",
"delimiter": ".",
"suffixes": [
"sass"
]
},
{
"type": "text/x-scss",
"string": "text/x-scss",
"mainType": "text",
"subType": "x-scss",
"delimiter": ".",
"suffixes": [
"scss"
]
} }
] ]
}, },
"output": { "output": {
"formats": [ "formats": [
{ {
"MediaType": "text/html+html", "MediaType": "text/html",
"name": "AMP", "name": "AMP",
"mediaType": { "mediaType": {
"type": "text/html", "type": "text/html",
"string": "text/html+html", "string": "text/html",
"mainType": "text", "mainType": "text",
"subType": "html", "subType": "html",
"suffix": "html", "delimiter": ".",
"delimiter": "." "suffixes": [
"html"
]
}, },
"path": "amp", "path": "amp",
"baseName": "index", "baseName": "index",
@ -1327,15 +1441,17 @@
"notAlternative": false "notAlternative": false
}, },
{ {
"MediaType": "text/css+css", "MediaType": "text/css",
"name": "CSS", "name": "CSS",
"mediaType": { "mediaType": {
"type": "text/css", "type": "text/css",
"string": "text/css+css", "string": "text/css",
"mainType": "text", "mainType": "text",
"subType": "css", "subType": "css",
"suffix": "css", "delimiter": ".",
"delimiter": "." "suffixes": [
"css"
]
}, },
"path": "", "path": "",
"baseName": "styles", "baseName": "styles",
@ -1347,15 +1463,17 @@
"notAlternative": true "notAlternative": true
}, },
{ {
"MediaType": "text/csv+csv", "MediaType": "text/csv",
"name": "CSV", "name": "CSV",
"mediaType": { "mediaType": {
"type": "text/csv", "type": "text/csv",
"string": "text/csv+csv", "string": "text/csv",
"mainType": "text", "mainType": "text",
"subType": "csv", "subType": "csv",
"suffix": "csv", "delimiter": ".",
"delimiter": "." "suffixes": [
"csv"
]
}, },
"path": "", "path": "",
"baseName": "index", "baseName": "index",
@ -1367,15 +1485,17 @@
"notAlternative": false "notAlternative": false
}, },
{ {
"MediaType": "text/calendar+ics", "MediaType": "text/calendar",
"name": "Calendar", "name": "Calendar",
"mediaType": { "mediaType": {
"type": "text/calendar", "type": "text/calendar",
"string": "text/calendar+ics", "string": "text/calendar",
"mainType": "text", "mainType": "text",
"subType": "calendar", "subType": "calendar",
"suffix": "ics", "delimiter": ".",
"delimiter": "." "suffixes": [
"ics"
]
}, },
"path": "", "path": "",
"baseName": "index", "baseName": "index",
@ -1387,15 +1507,17 @@
"notAlternative": false "notAlternative": false
}, },
{ {
"MediaType": "text/html+html", "MediaType": "text/html",
"name": "HTML", "name": "HTML",
"mediaType": { "mediaType": {
"type": "text/html", "type": "text/html",
"string": "text/html+html", "string": "text/html",
"mainType": "text", "mainType": "text",
"subType": "html", "subType": "html",
"suffix": "html", "delimiter": ".",
"delimiter": "." "suffixes": [
"html"
]
}, },
"path": "", "path": "",
"baseName": "index", "baseName": "index",
@ -1407,15 +1529,17 @@
"notAlternative": false "notAlternative": false
}, },
{ {
"MediaType": "application/json+json", "MediaType": "application/json",
"name": "JSON", "name": "JSON",
"mediaType": { "mediaType": {
"type": "application/json", "type": "application/json",
"string": "application/json+json", "string": "application/json",
"mainType": "application", "mainType": "application",
"subType": "json", "subType": "json",
"suffix": "json", "delimiter": ".",
"delimiter": "." "suffixes": [
"json"
]
}, },
"path": "", "path": "",
"baseName": "index", "baseName": "index",
@ -1427,15 +1551,17 @@
"notAlternative": false "notAlternative": false
}, },
{ {
"MediaType": "text/plain+txt", "MediaType": "text/plain",
"name": "ROBOTS", "name": "ROBOTS",
"mediaType": { "mediaType": {
"type": "text/plain", "type": "text/plain",
"string": "text/plain+txt", "string": "text/plain",
"mainType": "text", "mainType": "text",
"subType": "plain", "subType": "plain",
"suffix": "txt", "delimiter": ".",
"delimiter": "." "suffixes": [
"txt"
]
}, },
"path": "", "path": "",
"baseName": "robots", "baseName": "robots",
@ -1450,12 +1576,14 @@
"MediaType": "application/rss+xml", "MediaType": "application/rss+xml",
"name": "RSS", "name": "RSS",
"mediaType": { "mediaType": {
"type": "application/rss", "type": "application/rss+xml",
"string": "application/rss+xml", "string": "application/rss+xml",
"mainType": "application", "mainType": "application",
"subType": "rss", "subType": "rss",
"suffix": "xml", "delimiter": ".",
"delimiter": "." "suffixes": [
"xml"
]
}, },
"path": "", "path": "",
"baseName": "index", "baseName": "index",
@ -1467,15 +1595,17 @@
"notAlternative": false "notAlternative": false
}, },
{ {
"MediaType": "application/xml+xml", "MediaType": "application/xml",
"name": "Sitemap", "name": "Sitemap",
"mediaType": { "mediaType": {
"type": "application/xml", "type": "application/xml",
"string": "application/xml+xml", "string": "application/xml",
"mainType": "application", "mainType": "application",
"subType": "xml", "subType": "xml",
"suffix": "xml", "delimiter": ".",
"delimiter": "." "suffixes": [
"xml"
]
}, },
"path": "", "path": "",
"baseName": "sitemap", "baseName": "sitemap",
@ -2119,6 +2249,16 @@
], ],
"Examples": [] "Examples": []
}, },
"Append": {
"Description": "Append appends the arguments up to the last one to the slice in the last argument.\nThis construct allows template constructs like this:\n {{ $pages = $pages | append $p2 $p1 }}\nNote that with 2 arguments where both are slices of the same type,\nthe first slice will be appended to the second:\n {{ $pages = $pages | append .Site.RegularPages }}",
"Args": [
"args"
],
"Aliases": [
"append"
],
"Examples": []
},
"Apply": { "Apply": {
"Description": "Apply takes a map, array, or slice and returns a new slice with the function fname applied over it.", "Description": "Apply takes a map, array, or slice and returns a new slice with the function fname applied over it.",
"Args": [ "Args": [
@ -2185,6 +2325,17 @@
], ],
"Examples": [] "Examples": []
}, },
"Group": {
"Description": "Group groups a set of elements by the given key.\nThis is currently only supported for Pages.",
"Args": [
"key",
"items"
],
"Aliases": [
"group"
],
"Examples": []
},
"In": { "In": {
"Description": "In returns whether v is in the set l. l may be an array or slice.", "Description": "In returns whether v is in the set l. l may be an array or slice.",
"Args": [ "Args": [
@ -2262,6 +2413,19 @@
], ],
"Examples": [] "Examples": []
}, },
"NewScratch": {
"Description": "NewScratch creates a new Scratch which can be used to store values in a\nthread safe way.",
"Args": null,
"Aliases": [
"newScratch"
],
"Examples": [
[
"{{ $scratch := newScratch }}{{ $scratch.Add \"b\" 2 }}{{ $scratch.Add \"b\" 2 }}{{ $scratch.Get \"b\" }}",
"4"
]
]
},
"Querify": { "Querify": {
"Description": "Querify encodes the given parameters in URL-encoded form (\"bar=baz\u0026foo=quux\") sorted by key.", "Description": "Querify encodes the given parameters in URL-encoded form (\"bar=baz\u0026foo=quux\") sorted by key.",
"Args": [ "Args": [
@ -2486,7 +2650,7 @@
] ]
}, },
"Jsonify": { "Jsonify": {
"Description": "Jsonify encodes a given object to JSON.", "Description": "Jsonify encodes a given object to JSON, returning pretty printed output.",
"Args": [ "Args": [
"v" "v"
], ],
@ -2496,14 +2660,14 @@
"Examples": [ "Examples": [
[ [
"{{ (slice \"A\" \"B\" \"C\") | jsonify }}", "{{ (slice \"A\" \"B\" \"C\") | jsonify }}",
"[\"A\",\"B\",\"C\"]" "[\n \"A\",\n \"B\",\n \"C\"\n]"
] ]
] ]
} }
}, },
"fmt": { "fmt": {
"Errorf": { "Errorf": {
"Description": "", "Description": "Errorf formats according to a format specifier and returns the string as a\nvalue that satisfies error.",
"Args": [ "Args": [
"format", "format",
"a" "a"
@ -2675,7 +2839,7 @@
] ]
}, },
"Translate": { "Translate": {
"Description": "Translate ...", "Description": "Translate returns a translated string for id.",
"Args": [ "Args": [
"id", "id",
"args" "args"
@ -2838,19 +3002,6 @@
} }
}, },
"os": { "os": {
"Stat": {
"Description": "Stat returns a file infomation under the given path.",
"Args": [
"i"
],
"Aliases": null,
"Examples": [
[
"{{ (os.Stat \"foo.txt\").Name }}",
"foo.txt"
]
]
},
"FileExists": { "FileExists": {
"Description": "FileExists checks whether a file exists under the given path.", "Description": "FileExists checks whether a file exists under the given path.",
"Args": [ "Args": [
@ -2886,7 +3037,7 @@
], ],
"Examples": [ "Examples": [
[ [
"{{ range (readDir \".\") }}{{ .Name }}{{ end }}", "{{ range (readDir \"files\") }}{{ .Name }}{{ end }}",
"README.txt" "README.txt"
] ]
] ]
@ -2901,10 +3052,16 @@
], ],
"Examples": [ "Examples": [
[ [
"{{ readFile \"README.txt\" }}", "{{ readFile \"files/README.txt\" }}",
"Hugo Rocks!" "Hugo Rocks!"
] ]
] ]
},
"Stat": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
} }
}, },
"partials": { "partials": {
@ -3003,6 +3160,74 @@
] ]
} }
}, },
"resources": {
"Concat": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
"ExecuteAsTemplate": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
"Fingerprint": {
"Description": "Fingerprint transforms the given Resource with a MD5 hash of the content in\nthe RelPermalink and Permalink.",
"Args": [
"args"
],
"Aliases": [
"fingerprint"
],
"Examples": []
},
"FromString": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
"Get": {
"Description": "Get locates the filename given in Hugo's filesystems: static, assets and content (in that order)\nand creates a Resource object that can be used for further transformations.",
"Args": [
"filename"
],
"Aliases": null,
"Examples": []
},
"Minify": {
"Description": "Minify minifies the given Resource using the MediaType to pick the correct\nminifier.",
"Args": [
"r"
],
"Aliases": [
"minify"
],
"Examples": []
},
"PostCSS": {
"Description": "PostCSS processes the given Resource with PostCSS",
"Args": [
"args"
],
"Aliases": [
"postCSS"
],
"Examples": []
},
"ToCSS": {
"Description": "ToCSS converts the given Resource to CSS. You can optional provide an Options\nobject or a target path (string) as first argument.",
"Args": [
"args"
],
"Aliases": [
"toCSS"
],
"Examples": []
}
},
"safe": { "safe": {
"CSS": { "CSS": {
"Description": "CSS returns a given string as html/template CSS content.", "Description": "CSS returns a given string as html/template CSS content.",
@ -3165,6 +3390,19 @@
] ]
] ]
}, },
"FirstUpper": {
"Description": "FirstUpper returns a string with the first character as upper case.",
"Args": [
"s"
],
"Aliases": null,
"Examples": [
[
"{{ \"hugo rocks!\" | strings.FirstUpper }}",
"Hugo rocks!"
]
]
},
"HasPrefix": { "HasPrefix": {
"Description": "HasPrefix tests whether the input s begins with prefix.", "Description": "HasPrefix tests whether the input s begins with prefix.",
"Args": [ "Args": [
@ -3443,6 +3681,25 @@
] ]
} }
}, },
"templates": {
"Exists": {
"Description": "Exists returns whether the template with the given name exists.\nNote that this is the Unix-styled relative path including filename suffix,\ne.g. partials/header.html",
"Args": [
"name"
],
"Aliases": null,
"Examples": [
[
"{{ if (templates.Exists \"partials/header.html\") }}Yes!{{ end }}",
"Yes!"
],
[
"{{ if not (templates.Exists \"partials/doesnotexist.html\") }}No!{{ end }}",
"No!"
]
]
}
},
"time": { "time": {
"AsTime": { "AsTime": {
"Description": "AsTime converts the textual representation of the datetime string into\na time.Time interface.", "Description": "AsTime converts the textual representation of the datetime string into\na time.Time interface.",
@ -3680,7 +3937,7 @@
"Description": "Ref returns the absolute URL path to a given content item.", "Description": "Ref returns the absolute URL path to a given content item.",
"Args": [ "Args": [
"in", "in",
"refs" "args"
], ],
"Aliases": [ "Aliases": [
"ref" "ref"
@ -3701,7 +3958,7 @@
"Description": "RelRef returns the relative URL path to a given content item.", "Description": "RelRef returns the relative URL path to a given content item.",
"Args": [ "Args": [
"in", "in",
"refs" "args"
], ],
"Aliases": [ "Aliases": [
"relref" "relref"