Squashed 'docs/' changes from 30f32a624..e5aa641a6

e5aa641a6 remove erroneous foo
8307b474e Add hl_inline to highlight function documentation
8517b02d9 update GitHub 404 docs URL to prevent redirect
5c52c2715 remove aerobatic.com
3eb179558 Update syntax-highlighting.md
00cbe3f2f Check for nil Chroma .Aliases
45416515e netlify: Hugo 0.101.0
d5dcd1581 docs: Regen docshelper
4785e99b1 common: Add hugo.GoVersion
e679f1b7e resources/page: Add :slugorfilename attribute
f2cc72a1f Update spellcheck.yml (#1755)

git-subtree-dir: docs
git-subtree-split: e5aa641a629ce70de609a006fb9a57ee422922f5
This commit is contained in:
Bjørn Erik Pedersen 2022-06-28 20:51:33 +02:00
parent 475f87f685
commit bdf935d66c
11 changed files with 222 additions and 418 deletions

View file

@ -5,12 +5,15 @@ on: # rebuild any PRs and main branch changes
- "dependabot/**" - "dependabot/**"
pull_request: pull_request:
permissions:
contents: read
jobs: jobs:
spellcheck: spellcheck:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: streetsidesoftware/cspell-action@3bc52c39528d0214a947ff7f8b5c23ad3273435b - uses: streetsidesoftware/cspell-action@v2
with: with:
inline: warning inline: warning
strict: false strict: false

View file

@ -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. 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. 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. 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 [@spf13]: https://twitter.com/spf13
[Aerobatic]: https://www.aerobatic.com/
[Amazon S3]: https://aws.amazon.com/s3/ [Amazon S3]: https://aws.amazon.com/s3/
[Azure]: https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website [Azure]: https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website
[CloudFront]: https://aws.amazon.com/cloudfront/ "Amazon CloudFront" [CloudFront]: https://aws.amazon.com/cloudfront/ "Amazon CloudFront"

View file

@ -45,6 +45,7 @@ Options:
* `linenostart=199`: starts the line number count from 199. * `linenostart=199`: starts the line number count from 199.
* `anchorlinenos`: Configure anchors on line numbers. Valid values are `true` or `false`; * `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. * `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 ### Example: Highlight Shortcode

View file

@ -91,6 +91,9 @@ The following is a list of values that can be used in a `permalink` definition i
`:slug` `:slug`
: the content's slug (or title if no slug is provided in the front matter) : 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` `:filename`
: the content's filename (without extension) : the content's filename (without extension)

View file

@ -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). 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. Below you will find some of the most common and helpful pages from our documentation.
foo

View file

@ -54,6 +54,10 @@ hl_Lines
: String. Default is `""`.\ : 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. 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 style
: String. Default is `monokai`.\ : String. Default is `monokai`.\
The CSS styles to apply to the highlighted code. See the [style gallery] for examples. Case-sensitive. The CSS styles to apply to the highlighted code. See the [style gallery] for examples. Case-sensitive.

View file

@ -27,8 +27,8 @@ hugo.Generator
hugo.Version hugo.Version
: the current version of the Hugo binary you are using e.g. `0.63.2` : the current version of the Hugo binary you are using e.g. `0.63.2`
hugo.GoVersion
`hugo` returns an instance that contains the following functions: : returns the version of Go that the Hugo binary was built with. {{< new-in "0.101.0" >}}
hugo.Environment hugo.Environment
: the current running environment as defined through the `--environment` cli tag : 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 hugo.Deps
: See [hugo.Deps](#hugodeps) : See [hugo.Deps](#hugodeps)
## hugo.Deps ## hugo.Deps
{{< new-in "0.92.0" >}} {{< new-in "0.92.0" >}}
@ -112,4 +111,4 @@ An example table listing the dependencies:
{{ end }} {{ end }}
</tbody> </tbody>
</table> </table>
``` ```

View file

@ -17,7 +17,7 @@ aliases: []
toc: false 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. 404 pages will have all the regular [page variables][pagevars] available to use in the templates.

File diff suppressed because it is too large Load diff

View file

@ -1,6 +1,6 @@
<dl> <dl>
{{ range .Site.Data.docs.chroma.lexers }} {{ range .Site.Data.docs.chroma.lexers }}
<dt>{{ .Name }}</dt> <dt>{{ .Name }}</dt>
<dd>{{ delimit .Aliases ", " }}</dd> <dd>{{ with .Aliases }}{{ delimit . ", " }}{{ end }}</dd>
{{ end }} {{ end }}
</dl> </dl>

View file

@ -3,7 +3,7 @@ publish = "public"
command = "hugo --gc --minify" command = "hugo --gc --minify"
[context.production.environment] [context.production.environment]
HUGO_VERSION = "0.100.2" HUGO_VERSION = "0.101.0"
HUGO_ENV = "production" HUGO_ENV = "production"
HUGO_ENABLEGITINFO = "true" HUGO_ENABLEGITINFO = "true"
@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true"
command = "hugo --gc --minify --enableGitInfo" command = "hugo --gc --minify --enableGitInfo"
[context.split1.environment] [context.split1.environment]
HUGO_VERSION = "0.100.2" HUGO_VERSION = "0.101.0"
HUGO_ENV = "production" HUGO_ENV = "production"
[context.deploy-preview] [context.deploy-preview]
command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL" command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL"
[context.deploy-preview.environment] [context.deploy-preview.environment]
HUGO_VERSION = "0.100.2" HUGO_VERSION = "0.101.0"
[context.branch-deploy] [context.branch-deploy]
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL" command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
[context.branch-deploy.environment] [context.branch-deploy.environment]
HUGO_VERSION = "0.100.2" HUGO_VERSION = "0.101.0"
[context.next.environment] [context.next.environment]
HUGO_ENABLEGITINFO = "true" HUGO_ENABLEGITINFO = "true"