mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-11 17:17:09 -04:00
Miscellaneous edits
This commit is contained in:
parent
6d60920583
commit
4a1fcfc293
@ -69,7 +69,7 @@ You can create one `_index.md` for your homepage and one in each of your content
|
|||||||
. ⊢--^-⊣
|
. ⊢--^-⊣
|
||||||
. path slug
|
. path slug
|
||||||
. ⊢--^-⊣⊢---^---⊣
|
. ⊢--^-⊣⊢---^---⊣
|
||||||
. filepath
|
. file path
|
||||||
. ⊢------^------⊣
|
. ⊢------^------⊣
|
||||||
content/posts/_index.md
|
content/posts/_index.md
|
||||||
```
|
```
|
||||||
|
@ -216,7 +216,7 @@ file
|
|||||||
: (`string`) The file name to display.
|
: (`string`) The file name to display.
|
||||||
|
|
||||||
lang
|
lang
|
||||||
: (`string`) The code language. If you do not provide a `lang` argument, the code language is determined by the file extension. If the file extension is "html", sets the code language to `go-html-template`. Default is `text`.
|
: (`string`) The code language. If you do not provide a `lang` argument, the code language is determined by the file extension. If the file extension is `html`, sets the code language to `go-html-template`. Default is `text`.
|
||||||
|
|
||||||
### code-toggle
|
### code-toggle
|
||||||
|
|
||||||
|
@ -43,7 +43,7 @@ Access the data with either of the following:
|
|||||||
```
|
```
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
When working with local data, the filepath is relative to the working directory.
|
When working with local data, the file path is relative to the working directory.
|
||||||
|
|
||||||
You must not place CSV files in the project's data directory.
|
You must not place CSV files in the project's data directory.
|
||||||
{{% /note %}}
|
{{% /note %}}
|
||||||
|
@ -43,7 +43,7 @@ Access the data with either of the following:
|
|||||||
```
|
```
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
When working with local data, the filepath is relative to the working directory.
|
When working with local data, the file path is relative to the working directory.
|
||||||
{{% /note %}}
|
{{% /note %}}
|
||||||
|
|
||||||
Access remote data with either of the following:
|
Access remote data with either of the following:
|
||||||
|
@ -31,7 +31,7 @@ serpentine
|
|||||||
: (`bool`) Applicable to error diffusion dithering methods, serpentine controls whether the error diffusion matrix is applied in a serpentine manner, meaning that it goes right-to-left every other line. This greatly reduces line-type artifacts. Default is `true`.
|
: (`bool`) Applicable to error diffusion dithering methods, serpentine controls whether the error diffusion matrix is applied in a serpentine manner, meaning that it goes right-to-left every other line. This greatly reduces line-type artifacts. Default is `true`.
|
||||||
|
|
||||||
strength
|
strength
|
||||||
: (`float`) The strength at which to apply the dithering matrix, typically a value in the range [0, 1]. A value of `1.0` applies the dithering matrix at 100% strength (no modifification of the dither matrix). The `strength` is inversely proportional to contrast; reducing the strength increases the contrast. Setting `strength` to a value such as `0.8` can be useful to reduce noise in the dithered image. Default is `1.0`.
|
: (`float`) The strength at which to apply the dithering matrix, typically a value in the range [0, 1]. A value of `1.0` applies the dithering matrix at 100% strength (no modification of the dither matrix). The `strength` is inversely proportional to contrast; reducing the strength increases the contrast. Setting `strength` to a value such as `0.8` can be useful to reduce noise in the dithered image. Default is `1.0`.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -115,7 +115,7 @@ JSX {{< new-in 0.124.0 >}}
|
|||||||
: (`string`) How to handle/transform JSX syntax. One of: `transform`, `preserve`, `automatic`. Default is `transform`. Notably, the `automatic` transform was introduced in React 17+ and will cause the necessary JSX helper functions to be imported automatically. See https://esbuild.github.io/api/#jsx
|
: (`string`) How to handle/transform JSX syntax. One of: `transform`, `preserve`, `automatic`. Default is `transform`. Notably, the `automatic` transform was introduced in React 17+ and will cause the necessary JSX helper functions to be imported automatically. See https://esbuild.github.io/api/#jsx
|
||||||
|
|
||||||
JSXImportSource {{< new-in 0.124.0 >}}
|
JSXImportSource {{< new-in 0.124.0 >}}
|
||||||
: (`string`) Which library to use to automatically import its JSX helper functions from. This only works if `JSX` is set to `automatic`. The specified library needs to be installed through NPM and expose certain exports. See https://esbuild.github.io/api/#jsx-import-source
|
: (`string`) Which library to use to automatically import its JSX helper functions from. This only works if `JSX` is set to `automatic`. The specified library needs to be installed through npm and expose certain exports. See https://esbuild.github.io/api/#jsx-import-source
|
||||||
|
|
||||||
The combination of `JSX` and `JSXImportSource` is helpful if you want to use a non-React JSX library like Preact, e.g.:
|
The combination of `JSX` and `JSXImportSource` is helpful if you want to use a non-React JSX library like Preact, e.g.:
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ defaultMarkdownHandler|Description
|
|||||||
`pandoc`|[Pandoc]
|
`pandoc`|[Pandoc]
|
||||||
`rst`|[reStructuredText]
|
`rst`|[reStructuredText]
|
||||||
|
|
||||||
To use Asciidoc, Pandoc, or reStructuredText you must install the relevant renderer and update your [security policy].
|
To use AsciiDoc, Pandoc, or reStructuredText you must install the relevant renderer and update your [security policy].
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
Unless you need a unique capability provided by one of the alternate Markdown handlers, we strongly recommend that you use the default setting. Goldmark is fast, well maintained, conforms to the [CommonMark] specification, and is compatible with [GitHub Flavored Markdown] (GFM).
|
Unless you need a unique capability provided by one of the alternate Markdown handlers, we strongly recommend that you use the default setting. Goldmark is fast, well maintained, conforms to the [CommonMark] specification, and is compatible with [GitHub Flavored Markdown] (GFM).
|
||||||
@ -182,13 +182,13 @@ The embedded link render hook is automatically enabled for multilingual single-h
|
|||||||
|
|
||||||
(`bool`) If `true`, Goldmark renders raw HTML mixed within the Markdown. This is unsafe unless the content is under your control. Default is `false`.
|
(`bool`) If `true`, Goldmark renders raw HTML mixed within the Markdown. This is unsafe unless the content is under your control. Default is `false`.
|
||||||
|
|
||||||
## Asciidoc
|
## AsciiDoc
|
||||||
|
|
||||||
This is the default configuration for the AsciiDoc Markdown renderer:
|
This is the default configuration for the AsciiDoc Markdown renderer:
|
||||||
|
|
||||||
{{< code-toggle config=markup.asciidocExt />}}
|
{{< code-toggle config=markup.asciidocExt />}}
|
||||||
|
|
||||||
### Asciidoc settings explained
|
### AsciiDoc settings explained
|
||||||
|
|
||||||
###### attributes
|
###### attributes
|
||||||
|
|
||||||
|
@ -222,7 +222,7 @@ See [Configure Build](#configure-build).
|
|||||||
|
|
||||||
###### buildFuture
|
###### buildFuture
|
||||||
|
|
||||||
(`bool`) Include content with publishdate in the future. Default is `false`.
|
(`bool`) Include content with a future publication date. Default is `false`.
|
||||||
|
|
||||||
###### caches
|
###### caches
|
||||||
|
|
||||||
@ -238,7 +238,7 @@ See [Configure File Caches](#configure-file-caches).
|
|||||||
|
|
||||||
###### cascade
|
###### cascade
|
||||||
|
|
||||||
Pass down down default configuration values (front matter) to pages in the content tree. The options in site config is the same as in page front matter, see [Front Matter Cascade](/content-management/front-matter#cascade).
|
Pass down default configuration values (front matter) to pages in the content tree. The options in site config is the same as in page front matter, see [Front Matter Cascade](/content-management/front-matter#cascade).
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
For a website in a single language, define the `[[cascade]]` in [Front Matter](/content-management/front-matter#cascade). For a multilingual website, define the `[[cascade]]` in [Site Config](/getting-started/configuration/#cascade).
|
For a website in a single language, define the `[[cascade]]` in [Front Matter](/content-management/front-matter#cascade). For a multilingual website, define the `[[cascade]]` in [Site Config](/getting-started/configuration/#cascade).
|
||||||
@ -795,7 +795,7 @@ dir
|
|||||||
|
|
||||||
This is the directory where Hugo by default will store its file caches. See [Configure File Caches](#configure-file-caches).
|
This is the directory where Hugo by default will store its file caches. See [Configure File Caches](#configure-file-caches).
|
||||||
|
|
||||||
This can be set using the `cacheDir` config option or via the OS env variable `HUGO_CACHEDIR`.
|
This can be set using the `cacheDir` config option or via the OS environment variable `HUGO_CACHEDIR`.
|
||||||
|
|
||||||
If this is not set, Hugo will use, in order of preference:
|
If this is not set, Hugo will use, in order of preference:
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ action:
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Any JavaScript resource file can be transpiled and "tree shaken" using `js.Build` which takes for argument either a string for the filepath or a dict of options listed below.
|
Any JavaScript resource file can be transpiled and "tree shaken" using `js.Build` which takes for argument either a string for the file path or a dict of options listed below.
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user