Skip to content

Commit

Permalink
Squashed 'docs/' changes from 39a7fac34..316cec249
Browse files Browse the repository at this point in the history
316cec249 Update future events template example (#1595)
3bde7d489 Install mage outside module (#1592)
762e27eff Clarify ignoreFiles regex matching
4d0032051 Add id attribute to h2 elements (#1590)
8262b077c Improve inline resource examples (#1587)
2eae7c7ec fix disqus example name (#1588)
a772f4804 Added install instructions for openSUSE Tumbleweed (#1459)
7ad1c301b Remove screen capture from Hosting on GitHub page (#1586)
a58541f49 add more details on about gh-pages and baseURL on hosting-on-github.md (#1346)
3bd0b46dc Update configuration page (#1585)
4cf1f013e Update OS functions
2c45a95c2 Remove getting-started/code-toggle/
40fdff598 Describe artificial language private use subtags (#1577)
91011d210 Remove google_news from list of internal templates (#1576)
36c7879e4 Update the .Unix function
731063488 Remove a showcase
818c371a0 Update index.md
3136d39d9 netlify: Hugo 0.89.4
092bc9278 Merge branch 'tempv0.89.4'
18e01f105 releaser: Add release notes to /docs for release of 0.89.4
79135281f Correct and sort list of target image formats (#1574)
af4170c7e netlify: Hugo 0.89.3
7f5444251 Merge branch 'tempv0.89.3'
a32e4a6c2 releaser: Add release notes to /docs for release of 0.89.3
6dd3dc3f9 Update configuration.md
5fbe741d7 Update index.md (#1570)
37a69496f netlify: Bump to Hugo 0.89.2
3b293f1f4 Merge branch 'tempv0.89.2'
64c934e7a releaser: Add release notes to /docs for release of 0.89.2
919c51c7d Update index.md
13dd463b1 netlify: Hugo 0.89.1
d8cda1474 releaser: Add release notes to /docs for release of 0.89.1
a2adf7742 releaser: Add release notes to /docs for release of 0.89.1
c3088c4fc Add code toggle to menus page (#1568)
2d0f38978 Remove blank lines from code-toggle output (#1564)
7cf058bfd Add localization examples (#1563)
cf8627c2e Fixing typos, fixing incomplete link (#1561)
c78cc014b Document the removePathAccents setting
70beddaf4 Make corrections to 0.89.0 release notes (#1560)
1917195f0 Update index.md
7fb8e070c Run hugo --gc
1772d45fb Release 0.89.0
d9006179b Merge branch 'tempv0.89.0'
8db86b61e releaser: Add release notes to /docs for release of 0.89.0
abf268571 docs: Regen CLI docs
fbbdb0ab1 Update the timeout default
9cbd1c15a Fix description of lang.FormatNumberCustom
6043b54cc Remove "render" keyword from Host on Render page
f8ea8e84f Clarify description of front matter url (#1557)
91a0c9954 Update Twitter shortcode oEmbed endpoint
79a7405b8 Merge commit 'aa5ac36a3eb68b86c803caec703869efefc8447e'
57667bae6 hugofs: Add includeFiles and excludeFiles to mount configuration
0c9ee0a04 Allow multiple plugins in the PostCSS options map
155799e6b docs: Create path.Clean documentation

git-subtree-dir: docs
git-subtree-split: 316cec2494dc5f908283289371d74f36a73d3d8d
  • Loading branch information
bep committed Dec 8, 2021
1 parent aa5ac36 commit 8d9511a
Show file tree
Hide file tree
Showing 60 changed files with 759 additions and 464 deletions.
6 changes: 3 additions & 3 deletions content/en/commands/hugo_gen_chromastyles.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Generate CSS stylesheet for the Chroma code highlighter

### Synopsis

Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if pygmentsUseClasses is enabled in config.
Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if markup.highlight.noClasses is disabled in config.

See https://help.farbox.com/pygments.html for preview of available styles
See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles

```
hugo gen chromastyles [flags]
Expand All @@ -23,7 +23,7 @@ hugo gen chromastyles [flags]
-h, --help help for chromastyles
--highlightStyle string style used for highlighting lines (see https://github.com/alecthomas/chroma) (default "bg:#ffffcc")
--linesStyle string style used for line numbers (see https://github.com/alecthomas/chroma)
--style string highlighter style (see https://help.farbox.com/pygments.html) (default "friendly")
--style string highlighter style (see https://xyproto.github.io/splash/docs/) (default "friendly")
```

### Options inherited from parent commands
Expand Down
11 changes: 5 additions & 6 deletions content/en/content-management/front-matter.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ audio
: an array of paths to audio files related to the page; used by the `opengraph` [internal template](/templates/internal) to populate `og:audio`.

cascade
: a map of Front Matter keys whose values are passed down to the page's descendents unless overwritten by self or a closer ancestor's cascade. See [Front Matter Cascade](#front-matter-cascade) for details.
: a map of Front Matter keys whose values are passed down to the page's descendants unless overwritten by self or a closer ancestor's cascade. See [Front Matter Cascade](#front-matter-cascade) for details.

date
: the datetime assigned to this page. This is usually fetched from the `date` field in front matter, but this behaviour is configurable.
Expand Down Expand Up @@ -128,8 +128,7 @@ type
: the type of the content; this value will be automatically derived from the directory (i.e., the [section][]) if not specified in front matter.

url
: the full path to the content from the web root. It makes no assumptions about the path of the content file. It also ignores any language prefixes of
the multilingual feature.
: the full path to the content from the web root. It makes no assumptions about the path of the content file. See [URL Management](/content-management/urls/#set-url-in-front-matter).

videos
: an array of paths to videos related to the page; used by the `opengraph` [internal template](/templates/internal) to populate `og:video`.
Expand Down Expand Up @@ -157,7 +156,7 @@ show_comments: false

## Front Matter Cascade

Any node or section can pass down to descendents a set of Front Matter values as long as defined underneath the reserved `cascade` Front Matter key.
Any node or section can pass down to descendants a set of Front Matter values as long as defined underneath the reserved `cascade` Front Matter key.

### Target Specific Pages

Expand Down Expand Up @@ -202,9 +201,9 @@ cascade:
banner: images/typewriter.jpg
{{</ code-toggle >}}

With the above example the Blog section page and its descendents will return `images/typewriter.jpg` when `.Params.banner` is invoked unless:
With the above example the Blog section page and its descendants will return `images/typewriter.jpg` when `.Params.banner` is invoked unless:

- Said descendent has its own `banner` value set
- Said descendant has its own `banner` value set
- Or a closer ancestor node has its own `cascade.banner` value set.


Expand Down
2 changes: 1 addition & 1 deletion content/en/content-management/image-processing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ See https://github.com/disintegration/imaging for more. If you want to trade qua

By default the images is encoded in the source format, but you can set the target format as an option.

Valid values are `jpg`, `png`, `tif`, `bmp`, `gif` and `webp`.
Valid values are `bmp`, `gif`, `jpeg`, `jpg`, `png`, `tif`, `tiff`, and `webp`.

```go
{{ $image.Resize "600x jpg" }}
Expand Down
24 changes: 8 additions & 16 deletions content/en/content-management/menus.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ menu:
docs:
parent: "content-management"
weight: 120
weight: 120 #rem
weight: 120
aliases: [/extras/menus/]
toc: true
---
Expand Down Expand Up @@ -48,31 +48,24 @@ If all you need to do is add an entry to a menu, the simple form works well.

#### A Single Menu

```
---
{{< code-toggle >}}
menu: "main"
---
```
{{< /code-toggle >}}

#### Multiple Menus

```
---
{{< code-toggle >}}
menu: ["main", "footer"]
---
```
{{< /code-toggle >}}

#### Advanced


```
---
{{< code-toggle >}}
menu:
docs:
parent: 'extras'
weight: 20
---
```
{{< /code-toggle >}}

## Add Non-content Entries to a Menu

Expand Down Expand Up @@ -115,7 +108,7 @@ In this example, the top level of the menu is defined in your [site `config` fil

## Params

You can also add user-defined content to menu items via the `params` field.
You can also add user-defined content to menu items via the `params` field.

A common use case is to define a custom param to add a css class to a specific menu item.

Expand All @@ -130,7 +123,6 @@ A common use case is to define a custom param to add a css class to a specific m
class = "highlight-menu-item"
{{</ code-toggle >}}


## Render Menus

See [Menu Templates](/templates/menu-templates/) for information on how to render your site menus within your templates.
Expand Down
Loading

0 comments on commit 8d9511a

Please sign in to comment.