diff options
-rw-r--r-- | .github/workflows/spellcheck.yml | 7 | ||||
-rw-r--r-- | content/en/about/what-is-hugo.md | 3 | ||||
-rw-r--r-- | content/en/content-management/syntax-highlighting.md | 1 | ||||
-rw-r--r-- | content/en/content-management/urls.md | 3 | ||||
-rw-r--r-- | content/en/documentation.md | 1 | ||||
-rw-r--r-- | content/en/functions/highlight.md | 4 | ||||
-rw-r--r-- | content/en/functions/hugo.md | 7 | ||||
-rw-r--r-- | content/en/templates/404.md | 2 | ||||
-rw-r--r-- | data/docs.json | 590 | ||||
-rw-r--r-- | layouts/shortcodes/chroma-lexers.html | 10 | ||||
-rw-r--r-- | netlify.toml | 8 |
11 files changed, 220 insertions, 416 deletions
diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 0129bbb27..6f68fee18 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -5,12 +5,15 @@ on: # rebuild any PRs and main branch changes - "dependabot/**" pull_request: +permissions: + contents: read + jobs: spellcheck: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: streetsidesoftware/cspell-action@3bc52c39528d0214a947ff7f8b5c23ad3273435b + - uses: actions/checkout@v3 + - uses: streetsidesoftware/cspell-action@v2 with: inline: warning strict: false diff --git a/content/en/about/what-is-hugo.md b/content/en/about/what-is-hugo.md index b84f61f10..69ca1fddb 100644 --- a/content/en/about/what-is-hugo.md +++ b/content/en/about/what-is-hugo.md @@ -19,7 +19,7 @@ toc: true Hugo is a general-purpose website framework. Technically speaking, Hugo is a [static site generator][]. Unlike systems that dynamically build a page with each visitor request, Hugo builds pages when you create or update your content. Since websites are viewed far more often than they are edited, Hugo is designed to provide an optimal viewing experience for your website's end users and an ideal writing experience for website authors. -Websites built with Hugo are extremely fast and secure. Hugo sites can be hosted anywhere, including [Netlify][], [Heroku][], [GoDaddy][], [DreamHost][], [GitHub Pages][], [GitLab Pages][], [Surge][], [Aerobatic][], [Firebase][], [Google Cloud Storage][], [Amazon S3][], [Rackspace][], [Azure][], and [CloudFront][] and work well with CDNs. Hugo sites run without the need for a database or dependencies on expensive runtimes like Ruby, Python, or PHP. +Websites built with Hugo are extremely fast and secure. Hugo sites can be hosted anywhere, including [Netlify][], [Heroku][], [GoDaddy][], [DreamHost][], [GitHub Pages][], [GitLab Pages][], [Surge][], [Firebase][], [Google Cloud Storage][], [Amazon S3][], [Rackspace][], [Azure][], and [CloudFront][] and work well with CDNs. Hugo sites run without the need for a database or dependencies on expensive runtimes like Ruby, Python, or PHP. We think of Hugo as the ideal website creation tool with nearly instant build times, able to rebuild whenever a change is made. @@ -40,7 +40,6 @@ Hugo is for people who want to hand code their own website without worrying abou Hugo is for people building a blog, a company site, a portfolio site, documentation, a single landing page, or a website with thousands of pages. [@spf13]: https://twitter.com/spf13 -[Aerobatic]: https://www.aerobatic.com/ [Amazon S3]: https://aws.amazon.com/s3/ [Azure]: https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website [CloudFront]: https://aws.amazon.com/cloudfront/ "Amazon CloudFront" diff --git a/content/en/content-management/syntax-highlighting.md b/content/en/content-management/syntax-highlighting.md index 31f12f7d3..8ff270c54 100644 --- a/content/en/content-management/syntax-highlighting.md +++ b/content/en/content-management/syntax-highlighting.md @@ -45,6 +45,7 @@ Options: * `linenostart=199`: starts the line number count from 199. * `anchorlinenos`: Configure anchors on line numbers. Valid values are `true` or `false`; * `lineanchors`: Configure a prefix for the anchors on line numbers. Will be suffixed with `-`, so linking to the line number 1 with the option `lineanchors=prefix` adds the anchor `prefix-1` to the page. +* `hl_inline` Highlight inside a `<code>` (inline HTML element) tag. Valid values are `true` or `false`. The `code` tag will get a class with name `code-inline`. {{< new-in "0.101.0" >}} ### Example: Highlight Shortcode diff --git a/content/en/content-management/urls.md b/content/en/content-management/urls.md index f498d02ea..774bd9a58 100644 --- a/content/en/content-management/urls.md +++ b/content/en/content-management/urls.md @@ -91,6 +91,9 @@ The following is a list of values that can be used in a `permalink` definition i `:slug` : the content's slug (or title if no slug is provided in the front matter) +`:slugorfilename` +: the content's slug (or filename if no slug is provided in the front matter) + `:filename` : the content's filename (without extension) diff --git a/content/en/documentation.md b/content/en/documentation.md index 8364a42bb..77cf283fa 100644 --- a/content/en/documentation.md +++ b/content/en/documentation.md @@ -19,4 +19,3 @@ layout: documentation-home Hugo is the **world's fastest static website engine.** It's written in Go (aka Golang) and developed by [bep](https://github.com/bep), [spf13](https://github.com/spf13) and [friends](https://github.com/gohugoio/hugo/graphs/contributors). Below you will find some of the most common and helpful pages from our documentation. -foo diff --git a/content/en/functions/highlight.md b/content/en/functions/highlight.md index 1643fe075..40f3a78de 100644 --- a/content/en/functions/highlight.md +++ b/content/en/functions/highlight.md @@ -54,6 +54,10 @@ hl_Lines : String. Default is `""`.\ A space-separated list of lines to emphasize within the highlighted code. To emphasize lines 2, 3, 4, and 7, set this value to `2-4 7`. This option is independent of the `lineNoStart` option. +hl_inline +: Boolean. Default is `false`.\ +Render the highlighted code without a wrapping container. + style : String. Default is `monokai`.\ The CSS styles to apply to the highlighted code. See the [style gallery] for examples. Case-sensitive. diff --git a/content/en/functions/hugo.md b/content/en/functions/hugo.md index a495eae0a..1792f5a8d 100644 --- a/content/en/functions/hugo.md +++ b/content/en/functions/hugo.md @@ -27,8 +27,8 @@ hugo.Generator hugo.Version : the current version of the Hugo binary you are using e.g. `0.63.2` - -`hugo` returns an instance that contains the following functions: +hugo.GoVersion +: returns the version of Go that the Hugo binary was built with. {{< new-in "0.101.0" >}} hugo.Environment : the current running environment as defined through the `--environment` cli tag @@ -52,7 +52,6 @@ We highly recommend using `hugo.Generator` in your website's `<head>`. `hugo.Gen hugo.Deps : See [hugo.Deps](#hugodeps) - ## hugo.Deps {{< new-in "0.92.0" >}} @@ -112,4 +111,4 @@ An example table listing the dependencies: {{ end }} </tbody> </table> -```
\ No newline at end of file +``` diff --git a/content/en/templates/404.md b/content/en/templates/404.md index c638d89fa..87bbe1d36 100644 --- a/content/en/templates/404.md +++ b/content/en/templates/404.md @@ -17,7 +17,7 @@ aliases: [] toc: false --- -When using Hugo with [GitHub Pages](https://pages.github.com/), you can provide your own template for a [custom 404 error page](https://help.github.com/articles/custom-404-pages/) by creating a 404.html template file in your `/layouts` folder. When Hugo generates your site, the `404.html` file will be placed in the root. +When using Hugo with [GitHub Pages](https://pages.github.com/), you can provide your own template for a [custom 404 error page](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site) by creating a 404.html template file in your `/layouts` folder. When Hugo generates your site, the `404.html` file will be placed in the root. 404 pages will have all the regular [page variables][pagevars] available to use in the templates. diff --git a/data/docs.json b/data/docs.json index 7fc8e2f0b..fe4efeb22 100644 --- a/data/docs.json +++ b/data/docs.json @@ -4,7 +4,6 @@ { "Name": "ABAP", "Aliases": [ - "ABAP", "abap" ] }, @@ -17,33 +16,29 @@ { "Name": "ActionScript", "Aliases": [ - "actionscript", - "as" + "as", + "actionscript" ] }, { "Name": "ActionScript 3", "Aliases": [ - "actionscript3", - "as", - "as3" + "as3", + "actionscript3" ] }, { "Name": "Ada", "Aliases": [ "ada", - "ada2005", "ada95", - "adb", - "ads" + "ada2005" ] }, { "Name": "AL", "Aliases": [ - "al", - "dal" + "al" ] }, { @@ -61,11 +56,9 @@ { "Name": "ApacheConf", "Aliases": [ - "aconf", - "apache", "apacheconf", - "conf", - "htaccess" + "aconf", + "apache" ] }, { @@ -83,16 +76,13 @@ { "Name": "Arduino", "Aliases": [ - "arduino", - "ino" + "arduino" ] }, { "Name": "ArmAsm", "Aliases": [ - "S", - "armasm", - "s" + "armasm" ] }, { @@ -107,38 +97,26 @@ { "Name": "Ballerina", "Aliases": [ - "bal", "ballerina" ] }, { "Name": "Base Makefile", "Aliases": [ - "*", - "bsdmake", - "mak", "make", "makefile", "mf", - "mk" + "bsdmake" ] }, { "Name": "Bash", "Aliases": [ "bash", - "bash_*", - "bashrc", - "ebuild", - "eclass", - "env", - "exheres-0", - "exlib", - "ksh", "sh", - "shell", + "ksh", "zsh", - "zshrc" + "shell" ] }, { @@ -146,7 +124,6 @@ "Aliases": [ "bash-session", "console", - "sh-session", "shell-session" ] }, @@ -155,7 +132,6 @@ "Aliases": [ "bat", "batch", - "cmd", "dosbatch", "winbatch" ] @@ -176,11 +152,9 @@ { "Name": "BlitzBasic", "Aliases": [ - "b3d", - "bb", "blitzbasic", - "bplus", - "decls" + "b3d", + "bplus" ] }, { @@ -192,58 +166,43 @@ { "Name": "Brainfuck", "Aliases": [ - "b", - "bf", - "brainfuck" + "brainfuck", + "bf" ] }, { "Name": "C", "Aliases": [ - "c", - "h", - "idc", - "x[bp]m" + "c" ] }, { "Name": "C#", "Aliases": [ - "c#", - "cs", - "csharp" + "csharp", + "c#" ] }, { "Name": "C++", "Aliases": [ - "C", - "CPP", - "H", - "c++", - "cc", - "cp", "cpp", - "cxx", - "h++", - "hh", - "hpp", - "hxx" + "c++" ] }, { "Name": "Caddyfile", "Aliases": [ - "caddy", - "caddyfile" + "caddyfile", + "caddy" ] }, { "Name": "Caddyfile Directives", "Aliases": [ - "caddy-d", + "caddyfile-directives", "caddyfile-d", - "caddyfile-directives" + "caddy-d" ] }, { @@ -268,9 +227,8 @@ { "Name": "CFEngine3", "Aliases": [ - "cf", - "cf3", - "cfengine3" + "cfengine3", + "cf3" ] }, { @@ -290,56 +248,56 @@ "Name": "Cheetah", "Aliases": [ "cheetah", - "spitfire", - "spt", - "tmpl" + "spitfire" ] }, { "Name": "Clojure", "Aliases": [ - "clj", - "clojure" + "clojure", + "clj" ] }, { "Name": "CMake", "Aliases": [ - "cmake", - "txt" + "cmake" ] }, { "Name": "COBOL", "Aliases": [ - "COB", - "CPY", - "cob", - "cobol", - "cpy" + "cobol" ] }, { "Name": "CoffeeScript", "Aliases": [ - "coffee", "coffee-script", - "coffeescript" + "coffeescript", + "coffee" ] }, { "Name": "Common Lisp", "Aliases": [ + "common-lisp", "cl", + "lisp" + ] + }, + { + "Name": "Common Lisp", + "Aliases": [ "common-lisp", + "cl", "lisp" ] }, { "Name": "Coq", "Aliases": [ - "coq", - "v" + "coq" ] }, { @@ -359,17 +317,14 @@ "Name": "Cython", "Aliases": [ "cython", - "pxd", - "pxi", - "pyrex", - "pyx" + "pyx", + "pyrex" ] }, { "Name": "D", "Aliases": [ - "d", - "di" + "d" ] }, { @@ -382,7 +337,6 @@ "Name": "Diff", "Aliases": [ "diff", - "patch", "udiff" ] }, @@ -409,9 +363,7 @@ { "Name": "Dylan", "Aliases": [ - "dyl", - "dylan", - "intr" + "dylan" ] }, { @@ -437,20 +389,23 @@ { "Name": "EmacsLisp", "Aliases": [ - "el", + "emacs", "elisp", + "emacs-lisp" + ] + }, + { + "Name": "EmacsLisp", + "Aliases": [ "emacs", + "elisp", "emacs-lisp" ] }, { "Name": "Erlang", "Aliases": [ - "erl", - "erlang", - "es", - "escript", - "hrl" + "erlang" ] }, { @@ -470,59 +425,45 @@ "Name": "Fish", "Aliases": [ "fish", - "fishshell", - "load" + "fishshell" ] }, { "Name": "Forth", "Aliases": [ - "forth", - "frt", - "fs", - "fth" + "forth" ] }, { "Name": "Fortran", "Aliases": [ - "F03", - "F90", - "f03", - "f90", "fortran" ] }, { "Name": "FortranFixed", "Aliases": [ - "F", - "f", "fortranfixed" ] }, { "Name": "FSharp", "Aliases": [ - "fs", - "fsharp", - "fsi" + "fsharp" ] }, { "Name": "GAS", "Aliases": [ - "S", - "asm", "gas", - "s" + "asm" ] }, { "Name": "GDScript", "Aliases": [ - "gd", - "gdscript" + "gdscript", + "gd" ] }, { @@ -550,29 +491,22 @@ { "Name": "Gherkin", "Aliases": [ - "Cucumber", - "FEATURE", - "Gherkin", "cucumber", - "feature", - "gherkin" + "Cucumber", + "gherkin", + "Gherkin" ] }, { "Name": "GLSL", "Aliases": [ - "frag", - "geo", - "glsl", - "vert" + "glsl" ] }, { "Name": "Gnuplot", "Aliases": [ - "gnuplot", - "plot", - "plt" + "gnuplot" ] }, { @@ -589,6 +523,12 @@ ] }, { + "Name": "Go HTML Template", + "Aliases": [ + "go-html-template" + ] + }, + { "Name": "Go Text Template", "Aliases": [ "go-text-template" @@ -597,26 +537,22 @@ { "Name": "GraphQL", "Aliases": [ - "gql", "graphql", - "graphqls" + "graphqls", + "gql" ] }, { "Name": "Groff", "Aliases": [ - "1p", - "3pm", - "[1-9]", "groff", - "man", - "nroff" + "nroff", + "man" ] }, { "Name": "Groovy", "Aliases": [ - "gradle", "groovy" ] }, @@ -637,8 +573,8 @@ { "Name": "Haxe", "Aliases": [ - "haxe", "hx", + "haxe", "hxsl" ] }, @@ -663,10 +599,7 @@ { "Name": "HTML", "Aliases": [ - "htm", - "html", - "xhtml", - "xslt" + "html" ] }, { @@ -678,34 +611,29 @@ { "Name": "Hy", "Aliases": [ - "hy", "hylang" ] }, { "Name": "Idris", "Aliases": [ - "idr", - "idris" + "idris", + "idr" ] }, { "Name": "Igor", "Aliases": [ "igor", - "igorpro", - "ipf" + "igorpro" ] }, { "Name": "INI", "Aliases": [ + "ini", "cfg", - "dosini", - "editorconfig", - "gitconfig", - "inf", - "ini" + "dosini" ] }, { @@ -717,7 +645,6 @@ { "Name": "J", "Aliases": [ - "ijs", "j" ] }, @@ -730,10 +657,8 @@ { "Name": "JavaScript", "Aliases": [ - "javascript", "js", - "jsm", - "mjs" + "javascript" ] }, { @@ -745,8 +670,8 @@ { "Name": "Julia", "Aliases": [ - "jl", - "julia" + "julia", + "jl" ] }, { @@ -758,42 +683,37 @@ { "Name": "Kotlin", "Aliases": [ - "kotlin", - "kt" + "kotlin" ] }, { "Name": "Lighttpd configuration file", "Aliases": [ - "lighttpd", - "lighty" + "lighty", + "lighttpd" ] }, { "Name": "LLVM", "Aliases": [ - "ll", "llvm" ] }, { "Name": "Lua", "Aliases": [ - "lua", - "wlua" + "lua" ] }, { "Name": "Mako", "Aliases": [ - "mako", - "mao" + "mako" ] }, { "Name": "markdown", "Aliases": [ - "markdown", "md", "mkd" ] @@ -801,28 +721,20 @@ { "Name": "Mason", "Aliases": [ - "m", - "mason", - "mc", - "mhtml", - "mi" + "mason" ] }, { "Name": "Mathematica", "Aliases": [ - "cdf", - "ma", "mathematica", "mma", - "nb", - "nbp" + "nb" ] }, { "Name": "Matlab", "Aliases": [ - "m", "matlab" ] }, @@ -835,10 +747,8 @@ { "Name": "Meson", "Aliases": [ - "build", "meson", - "meson.build", - "txt" + "meson.build" ] }, { @@ -850,10 +760,8 @@ { "Name": "MiniZinc", "Aliases": [ - "MZN", - "dzn", - "fzn", "minizinc", + "MZN", "mzn" ] }, @@ -866,16 +774,13 @@ { "Name": "Modula-2", "Aliases": [ - "def", - "m2", - "mod", - "modula2" + "modula2", + "m2" ] }, { "Name": "MonkeyC", "Aliases": [ - "mc", "monkeyc" ] }, @@ -889,36 +794,31 @@ { "Name": "Myghty", "Aliases": [ - "myghty", - "myt" + "myghty" ] }, { "Name": "MySQL", "Aliases": [ "mysql", - "sql" + "mariadb" ] }, { "Name": "NASM", "Aliases": [ - "ASM", - "asm", "nasm" ] }, { "Name": "Newspeak", "Aliases": [ - "newspeak", - "ns2" + "newspeak" ] }, { "Name": "Nginx configuration file", "Aliases": [ - "conf", "nginx" ] }, @@ -932,69 +832,53 @@ { "Name": "Nix", "Aliases": [ - "nix", - "nixos" + "nixos", + "nix" ] }, { "Name": "Objective-C", "Aliases": [ - "h", - "m", - "obj-c", - "objc", "objective-c", - "objectivec" + "objectivec", + "obj-c", + "objc" ] }, { "Name": "OCaml", "Aliases": [ - "ml", - "mli", - "mll", - "mly", "ocaml" ] }, { "Name": "Octave", "Aliases": [ - "m", "octave" ] }, { "Name": "OnesEnterprise", |