mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
Squashed 'docs/' changes from a26d0e610..7297c1172
7297c1172 Add note about caching for Hugo Pipes. c91be3403 minor markdown, capitalization and spelling fixes (#1183) fd4a103bf Fix several 404 errors (#1162) 69378bc20 Update related.md 28c24e95f Add note on setting baseURL 7b1502c99 minor typo fix (#1180) 33abeb4fe Update related.md 4887563f6 Update js.md ee5f1de2e Hugo 0.74.3 986ea0c8e releaser: Add release notes to /docs for release of 0.74.3 3299b44bd Fix Asciidoctor args bcb950347 resources/js: Add option for setting bundle format 3f8324918 resources/js: Add es5 build target git-subtree-dir: docs git-subtree-split: 7297c1172754078511ac1c10ca0dfd4cab629506
This commit is contained in:
Bjørn Erik Pedersen
parent
28bd06265e
commit
cb39847dee
17 changed files with 72 additions and 37 deletions
|
|
@ -33,7 +33,7 @@ The current list of content formats in Hugo:
|
|||
| Blackfriday | blackfriday |Blackfriday will eventually be deprecated.|
|
||||
|MMark|mmark|Mmark is deprecated and will be removed in a future release.|
|
||||
|Emacs Org-Mode|org|See [go-org](https://github.com/niklasfasching/go-org).|
|
||||
|AsciiDoc|asciidoc, adoc, ad|Needs AsciiDoc or [Asciidoctor][ascii] installed.|
|
||||
|AsciiDoc|asciidocext, adoc, ad|Needs [Asciidoctor][ascii] installed.|
|
||||
|RST|rst|Needs [RST](http://docutils.sourceforge.net/rst.html) installed.|
|
||||
|Pandoc|pandoc, pdc|Needs [Pandoc](https://www.pandoc.org/) installed.|
|
||||
|HTML|html, htm|To be treated as a content file, with layout, shortcodes etc., it must have front matter. If not, it will be copied as-is.|
|
||||
|
|
@ -44,17 +44,17 @@ The `markup identifier` is fetched from either the `markup` variable in front ma
|
|||
## External Helpers
|
||||
|
||||
Some of the formats in the table above needs external helpers installed on your PC. For example, for AsciiDoc files,
|
||||
Hugo will try to call the `asciidoctor` or `asciidoc` command. This means that you will have to install the associated
|
||||
Hugo will try to call the `asciidoctor` command. This means that you will have to install the associated
|
||||
tool on your machine to be able to use these formats.
|
||||
|
||||
Hugo passes reasonable default arguments to these external helpers by default:
|
||||
|
||||
- `asciidoctor`: `--no-header-footer -v -`
|
||||
- `asciidoctor`: `--no-header-footer --trace -`
|
||||
- `rst2html`: `--leave-comments --initial-header-level=2`
|
||||
- `pandoc`: `--mathjax`
|
||||
|
||||
{{% warning "Performance of External Helpers" %}}
|
||||
Because additional formats are external commands generation performance will rely heavily on the performance of the external tool you are using. As this feature is still in its infancy, feedback is welcome.
|
||||
Because additional formats are external commands, generation performance will rely heavily on the performance of the external tool you are using. As this feature is still in its infancy, feedback is welcome.
|
||||
{{% /warning %}}
|
||||
|
||||
### External Helper AsciiDoc
|
||||
|
|
@ -74,14 +74,14 @@ Asciidoctor parameters can be customized in Hugo:
|
|||
Parameter | Default | Comment
|
||||
--- | --- | ---
|
||||
backend | `html5` | Don't change this unless you know what you are doing.
|
||||
doctype | `article` | Document type (article, book or manpage).
|
||||
doctype | `article` | Currently supported Document type is `article`.
|
||||
extensions | | Possible extensions are `asciidoctor-html5s`, `asciidoctor-bibtex`, `asciidoctor-diagram`, `asciidoctor-interdoc-reftext`, `asciidoctor-katex`, `asciidoctor-latex`, `asciidoctor-mathematical`, `asciidoctor-question`, `asciidoctor-rouge`.
|
||||
attributes | | Variables to be referenced in your `adoc` file. This is a list of variable name/value maps. See [Asciidoctor#attributes](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#attributes-and-substitutions).
|
||||
noheaderorfooter | true | Output an embeddable document, which excludes the header, the footer, and everything outside the body of the document. Don't change this unless you know what you are doing.
|
||||
safemode | `unsafe` | Safe mode level `unsafe`, `safe`, `server` or `secure`. Don't change this unless you know what you are doing.
|
||||
sectionnumbers | `false` | Auto-number section titles.
|
||||
verbose | `true` | Verbosely print processing information and configuration file checks to stderr.
|
||||
trace | `false` | Include backtrace information on errors.
|
||||
verbose | `false` | Verbosely print processing information and configuration file checks to stderr.
|
||||
trace | `true` | Include backtrace information on errors.
|
||||
failurelevel | `fatal` | The minimum logging level that triggers a non-zero exit code (failure).
|
||||
workingfoldercurrent | `false` | Set the working folder to the rendered `adoc` file, so [include](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files) will work with relative paths. This setting uses the `asciidoctor` cli parameter `--base-dir` and attribute `outdir=`. For rendering [asciidoctor-diagram](https://asciidoctor.org/docs/asciidoctor-diagram/) `workingfoldercurrent` must be set to `true`.
|
||||
|
||||
|
|
@ -89,7 +89,6 @@ workingfoldercurrent | `false` | Set the working folder to the rendered `adoc` f
|
|||
[markup.asciidocext]
|
||||
extensions = ["asciidoctor-html5s", "asciidoctor-diagram"]
|
||||
workingFolderCurrent = true
|
||||
trace = true
|
||||
[markup.asciidocext.attributes]
|
||||
my-base-url = "https://example.com/"
|
||||
my-attribute-name = "my value"
|
||||
|
|
|
|||
|
|
@ -294,7 +294,7 @@ disableLatLong = false
|
|||
|
||||
## Smart Cropping of Images
|
||||
|
||||
By default, Hugo will use the [Smartcrop](https://github.com/muesli/smartcrop), a library created by [muesli](https://github.com/muesli), when cropping images with `.Fill`. You can set the anchor point manually, but in most cases the smart option will make a good choice. And we will work with the library author to improve this in the future.
|
||||
By default, Hugo will use [Smartcrop](https://github.com/muesli/smartcrop), a library created by [muesli](https://github.com/muesli), when cropping images with `.Fill`. You can set the anchor point manually, but in most cases the smart option will make a good choice. And we will work with the library author to improve this in the future.
|
||||
|
||||
An example using the sunset image from above:
|
||||
|
||||
|
|
|
|||
|
|
@ -18,8 +18,8 @@ Page Bundles are a way to group [Page Resources](/content-management/page-resour
|
|||
|
||||
A Page Bundle can be one of:
|
||||
|
||||
- Leaf Bundle (leaf means it has no children)
|
||||
- Branch Bundle (home page, section, taxonomy terms, taxonomy list)
|
||||
- Leaf Bundle (leaf means it has no children)
|
||||
- Branch Bundle (home page, section, taxonomy terms, taxonomy list)
|
||||
|
||||
| | Leaf Bundle | Branch Bundle |
|
||||
|-------------------------------------|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ Hugo provides a sensible default configuration of Related Content, but you can f
|
|||
|
||||
Without any `related` configuration set on the project, Hugo's Related Content methods will use the following.
|
||||
|
||||
```yaml
|
||||
{{< code-toggle file="config" >}}
|
||||
related:
|
||||
threshold: 80
|
||||
includeNewer: false
|
||||
|
|
@ -82,7 +82,7 @@ related:
|
|||
weight: 100
|
||||
- name: date
|
||||
weight: 10
|
||||
```
|
||||
{{< /code-toggle >}}
|
||||
|
||||
Custom configuration should be set using the same syntax.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,14 +16,12 @@ aliases: [/extras/highlighting/,/extras/highlight/,/tools/syntax-highlighting/]
|
|||
toc: true
|
||||
---
|
||||
|
||||
|
||||
Hugo uses [Chroma](https://github.com/alecthomas/chroma) as its code highlighter; it is built in Go and is really, really fast -- and for the most important parts compatible with Pygments we used before.
|
||||
|
||||
## Configure Syntax Highlighter
|
||||
|
||||
See [Configure Highlight](/getting-started/configuration-markup#highlight).
|
||||
|
||||
|
||||
## Generate Syntax Highlighter CSS
|
||||
|
||||
If you run with `pygmentsUseClasses=true` in your site config, you need a style sheet.
|
||||
|
|
@ -36,7 +34,6 @@ hugo gen chromastyles --style=monokai > syntax.css
|
|||
|
||||
Run `hugo gen chromastyles -h` for more options. See https://xyproto.github.io/splash/docs/ for a gallery of available styles.
|
||||
|
||||
|
||||
## Highlight Shortcode
|
||||
|
||||
Highlighting is carried out via the [built-in shortcode](/content-management/shortcodes/) `highlight`. `highlight` takes exactly one required parameter for the programming language to be highlighted and requires a closing shortcode. Note that `highlight` is *not* used for client-side javascript highlighting.
|
||||
|
|
@ -80,8 +77,6 @@ func GetTitleFunc(style string) func(s string) string {
|
|||
}
|
||||
{{< / highlight >}}
|
||||
|
||||
|
||||
|
||||
## Highlight Template Func
|
||||
|
||||
See [Highlight](/functions/highlight/).
|
||||
|
|
|
|||
|
|
@ -24,9 +24,8 @@ A collection of all themes created by the Hugo community, including screenshots
|
|||
|
||||
Another great site for Hugo themes is [jamstackthemes.dev/](https://jamstackthemes.dev/ssg/hugo/).
|
||||
|
||||
|
||||
### Add Your Theme to the Repo
|
||||
|
||||
In order to add your Hugo theme to [themes.gohugo.io] please [open up a new issue in the theme repository](https://github.com/gohugoio/hugoThemes/issues/new?template=theme-submission.md). **Please make sure that you've read the theme submission guidelines in the [README](https://github.com/gohugoio/hugoThemes/blob/master/README.md#adding-a-theme-to-the-list) of the hugoThemes repository.**
|
||||
In order to add your Hugo theme to [themes.gohugo.io] please [open up a new issue in the theme repository](https://github.com/gohugoio/hugoThemes/issues/new?template=theme-submission.md). **Please make sure that you've read the theme submission guidelines in the [README](https://github.com/gohugoio/hugoThemes/blob/master/README.md#adding-a-theme-to-the-list) of the hugoThemes repository.**
|
||||
|
||||
[themes.gohugo.io]: https://themes.gohugo.io/
|
||||
|
|
|
|||
|
|
@ -62,5 +62,5 @@ You can use `after` in combination with the [`first` function][] and Hugo's [pow
|
|||
|
||||
[`first` function]: /functions/first/
|
||||
[list/section page]: /templates/section-templates/
|
||||
[lists]: /lists/
|
||||
[lists]: /templates/lists/#order-content
|
||||
[slice]: /functions/slice/
|
||||
|
|
|
|||
|
|
@ -289,8 +289,6 @@ Once this workflow is established, you can update your website automatically by
|
|||
|
||||
[The source code for the site used in this guide is available on GitHub][guidesource], as is the [Wercker Hugo Build step][guidestep].
|
||||
|
||||
If you want to see an example of how you can deploy to S3 instead of GitHub pages, check [Wercker's documentation][werckerdocs] for guidance on setup.
|
||||
|
||||
[1]: /images/hosting-and-deployment/deployment-with-wercker/creating-a-basic-hugo-site.png
|
||||
[2]: /images/hosting-and-deployment/deployment-with-wercker/adding-the-project-to-github.png
|
||||
[3]: /images/hosting-and-deployment/deployment-with-wercker/wercker-sign-up.png
|
||||
|
|
@ -321,4 +319,3 @@ If you want to see an example of how you can deploy to S3 instead of GitHub page
|
|||
[hugoconfig]: /getting-started/configuration/
|
||||
[publicappurl]: https://app.wercker.com/#applications/5586dcbdaf7de9c51b02b0d5
|
||||
[quickstart]: /getting-started/quick-start/
|
||||
[werckerdocs]: http://devcenter.wercker.com/docs/deploy/s3.html
|
||||
|
|
|
|||
|
|
@ -56,11 +56,10 @@ In the rendered page response, the `https://__baseurl__` will be replaced with y
|
|||
|
||||
We will now create a git repository and then push our code to Bitbucket. In Bitbucket, create a repository.
|
||||
|
||||
![][1]
|
||||
![Bitbucket Screenshot][1]
|
||||
|
||||
[1]: /images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-create-repo.png
|
||||
|
||||
|
||||
```
|
||||
# initialize new git repository
|
||||
git init
|
||||
|
|
@ -133,11 +132,10 @@ Your code will be committed to Bitbucket, Bitbucket Pipelines will run your buil
|
|||
|
||||
At this point, you can now create and edit blog posts directly in the Bitbucket UI.
|
||||
|
||||
![][2]
|
||||
![Bitbucket blog Screenshot][2]
|
||||
|
||||
[2]: /images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-blog-post.png
|
||||
|
||||
|
||||
## Suggested next steps
|
||||
|
||||
The code for this example can be found in this Bitbucket [repository](https://bitbucket.org/dundonian/hugo-docs-test). Aerobatic also provides a number of additional [plugins](https://www.aerobatic.com/docs) such as auth and redirects that you can use for your Hugo site.
|
||||
|
|
|
|||
|
|
@ -77,6 +77,10 @@ That's it! You can now follow the CI agent building your page at `https://gitlab
|
|||
|
||||
After the build has passed, your new website is available at `https://<YourUsername>.gitlab.io/<your-hugo-site>/`.
|
||||
|
||||
{{% note %}}
|
||||
Make sure your `baseURL` key-value in your [site configuration](/getting-started/configuration/) reflects the full URL of your GitLab pages repository if you're using the default GitLab Pages URL (e.g., `https://<YourUsername>.gitlab.io/<your-hugo-site>/`) and not a custom domain.
|
||||
{{% /note %}}
|
||||
|
||||
## Next Steps
|
||||
|
||||
GitLab supports using custom CNAME's and TLS certificates. For more details on GitLab Pages, see the [GitLab Pages setup documentation](https://about.gitlab.com/2016/04/07/gitlab-pages-setup/).
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ pages:
|
|||
- master
|
||||
|
||||
```
|
||||
Using this integration method, you will have to specify the Zone ID and your [KeyCDN API](https://www.keycdn.com/api) key as secret variables. To do this, navigate to the top-left menu bar in GitLab and select Projects. Then, select your project and click on the Settings page. Finally, select Pipelines from the sub-menu and scroll down to the Secret Variable section.
|
||||
Using this integration method, you will have to specify the Zone ID and your [KeyCDN API](https://www.keycdn.com/api) key as secret variables. To do this, navigate to the top-left menu bar in GitLab and select Projects. Then, select your project and click on the Settings page. Finally, select Pipelines from the sub-menu and scroll down to the Secret Variable section.
|
||||
|
||||
The Secret Variable for your Zone ID should look similar to:
|
||||
|
||||
|
|
@ -89,6 +89,6 @@ git push -u origin master
|
|||
|
||||
You can watch the progress and CI job output in your Gitlab project under “Pipelines”.
|
||||
|
||||
After verifying your CI job ran without issues, first check that your GitLab page shows up under `https://youruser.gitlab.io/reponame/` (it might look broken depending on your browser settings as all links point to your KeyCDN zone – don’t worry about that) and then by heading to whatever Zonealias / Zone URL you defined.
|
||||
After verifying your CI job ran without issues, first check that your GitLab page shows up under `https://youruser.gitlab.io/reponame/` (it might look broken depending on your browser settings as all links point to your KeyCDN zone – don’t worry about that) and then by heading to whatever Zone alias / Zone URL you defined.
|
||||
|
||||
To learn more about Hugo hosting options with KeyCDN, check out the complete [Hugo hosting with KeyCDN integration guide](https://www.keycdn.com/support/hugo-hosting/).
|
||||
|
|
|
|||
|
|
@ -50,3 +50,15 @@ The example above can therefore also be written as follows:
|
|||
{{ $style := resources.Get "sass/main.scss" | toCSS | minify | fingerprint }}
|
||||
<link rel="stylesheet" href="{{ $style.Permalink }}">
|
||||
```
|
||||
|
||||
### Caching
|
||||
|
||||
Hugo Pipes invocations are cached based on the entire _pipe chain_.
|
||||
|
||||
An example of a pipe chain is:
|
||||
|
||||
```go-html-template
|
||||
{{ $mainJs := resources.Get "js/main.js" | js.Build "main.js" | minify | fingerprint }}
|
||||
```
|
||||
|
||||
The pipe chain is only invoked the first time it is encountered in a site build, and results are otherwise loaded from cache. As such, Hugo Pipes can be used in templates which are executed thousands or millions of times without negatively impacting the build performance.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ minify [bool]
|
|||
|
||||
target [string]
|
||||
: The language target.
|
||||
One of: `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`.
|
||||
One of: `es5`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020` or `esnext`.
|
||||
Default is `esnext`.
|
||||
|
||||
externals [slice]
|
||||
|
|
@ -45,6 +45,11 @@ defines [map]
|
|||
{{ $defines := dict "process.env.NODE_ENV" `"development"` }}
|
||||
```
|
||||
|
||||
format [string] {{< new-in "0.74.3" >}}
|
||||
: The output format.
|
||||
One of: `iife`, `cjs`, `esm`.
|
||||
Default is `iife`, a self-executing function, suitable for inclusion as a <script> tag.
|
||||
|
||||
### Examples
|
||||
|
||||
```go-html-template
|
||||
|
|
|
|||
26
content/en/news/0.74.3-relnotes/index.md
Normal file
26
content/en/news/0.74.3-relnotes/index.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
|
||||
---
|
||||
date: 2020-07-23
|
||||
title: "Hugo 0.74.3: A couple of Bug Fixes"
|
||||
description: "This version fixes a couple of bugs introduced in 0.74.0."
|
||||
categories: ["Releases"]
|
||||
images:
|
||||
- images/blog/hugo-bug-poster.png
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
This is a bug-fix release with a couple of important fixes.
|
||||
|
||||
* publisher: Collect transition attributes as classes [00e00da2](https://github.com/gohugoio/hugo/commit/00e00da233ab4d643de90bafca00f60ee0bbe785) [@bep](https://github.com/bep) [#7509](https://github.com/gohugoio/hugo/issues/7509)
|
||||
* Fix Asciidoctor args [45c665d3](https://github.com/gohugoio/hugo/commit/45c665d396ed368261f4a63ceee753c7f6dc5bf9) [@helfper](https://github.com/helfper) [#7493](https://github.com/gohugoio/hugo/issues/7493)
|
||||
* Fix date format in internal schema template [a06c06a5](https://github.com/gohugoio/hugo/commit/a06c06a5c202de85ff47792b7468bfaeec2fea12) [@jmooring](https://github.com/jmooring) [#7495](https://github.com/gohugoio/hugo/issues/7495)
|
||||
* resources/js: Add option for setting bundle format [0256959a](https://github.com/gohugoio/hugo/commit/0256959a358bb26b983c9d9496862b0fdf387621) [@bep](https://github.com/bep) [#7503](https://github.com/gohugoio/hugo/issues/7503)
|
||||
* resources/js: Simplify options handling [eded9ac2](https://github.com/gohugoio/hugo/commit/eded9ac2a05b9a7244c25c70ca8f761b69b33385) [@bep](https://github.com/bep) [#7499](https://github.com/gohugoio/hugo/issues/7499)
|
||||
* make sure documentation intro text only appears once [8d725128](https://github.com/gohugoio/hugo/commit/8d72512825b4cee12dc1952004f48fd076a3517b) [@TheHippo](https://github.com/TheHippo)
|
||||
* resources/js: Add es5 build target [e81aef0a](https://github.com/gohugoio/hugo/commit/e81aef0a954623e4a19062d1534bd8c2af97102a) [@bep](https://github.com/bep)
|
||||
* deps: esbuild v0.6.5 [9f919147](https://github.com/gohugoio/hugo/commit/9f9191471ec501f1f957020726f939c9ef48e193) [@bep](https://github.com/bep)
|
||||
|
||||
|
||||
|
||||
|
|
@ -152,7 +152,7 @@ Various optional metadata can also be set:
|
|||
- The first 6 `tags` on the page are used for the tags metadata.
|
||||
- The `series` taxonomy is used to specify related "see also" pages by placing them in the same series.
|
||||
|
||||
If using YouTube this will produce a og:video tag like `<meta property="og:video" content="url">`. If using a YouTube link make sure this is in **https://www.youtube.com/v/NlXVWtgLNjY** not __https://www.youtube.com/watch?v=NlXVWtgLNjY__
|
||||
If using YouTube this will produce a og:video tag like `<meta property="og:video" content="url">`. Use the `https://youtu.be/<id>` format with YouTube videos (example: `https://youtu.be/qtIqKaDlqXo`).
|
||||
|
||||
### Use the Open Graph Template
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ The following is a list of site-level (aka "global") variables. Many of these va
|
|||
|
||||
## Get the Site object from a partial
|
||||
|
||||
All the methods below, e.g. `.Site.RegularPages` can also be reached via the global `site` function, e.g. `site.RegularPages`, which can be handy in partials where the `Page` object isn't easily available. {{< new-in "0.53.0" >}}.
|
||||
All the methods below, e.g. `.Site.RegularPages` can also be reached via the global `site` function, e.g. `site.RegularPages`, which can be handy in partials where the `Page` object isn't easily available. {{< new-in "0.53" >}}.
|
||||
|
||||
## Site Variables List
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ publish = "public"
|
|||
command = "hugo --gc --minify"
|
||||
|
||||
[context.production.environment]
|
||||
HUGO_VERSION = "0.74.2"
|
||||
HUGO_VERSION = "0.74.3"
|
||||
HUGO_ENV = "production"
|
||||
HUGO_ENABLEGITINFO = "true"
|
||||
|
||||
|
|
@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true"
|
|||
command = "hugo --gc --minify --enableGitInfo"
|
||||
|
||||
[context.split1.environment]
|
||||
HUGO_VERSION = "0.74.2"
|
||||
HUGO_VERSION = "0.74.3"
|
||||
HUGO_ENV = "production"
|
||||
|
||||
[context.deploy-preview]
|
||||
command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL"
|
||||
|
||||
[context.deploy-preview.environment]
|
||||
HUGO_VERSION = "0.74.2"
|
||||
HUGO_VERSION = "0.74.3"
|
||||
|
||||
[context.branch-deploy]
|
||||
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
|
||||
|
||||
[context.branch-deploy.environment]
|
||||
HUGO_VERSION = "0.74.2"
|
||||
HUGO_VERSION = "0.74.3"
|
||||
|
||||
[context.next.environment]
|
||||
HUGO_ENABLEGITINFO = "true"
|
||||
|
|
|
|||
Loading…
Reference in a new issue