Skip to content

Commit

Permalink
docs: correct editURL config instruction (#215)
Browse files Browse the repository at this point in the history
* docs: fix the documentation error about editURL

* docs: fix the documentation error about editURL

* Update configuration.md

* Update configuration.zh-cn.md

---------

Co-authored-by: Xin <xin@imfing.com>
  • Loading branch information
longlin10086 and imfing committed Nov 21, 2023
1 parent 7f0a35a commit 7772313
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
5 changes: 2 additions & 3 deletions exampleSite/content/docs/guide/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,13 +143,12 @@ params:
```

The edit links will be automatically generated for each page based on the provided url as root directory.
If you want to set edit link for a specific page, you can set the `params.editURL` parameter in the front matter of the page:
If you want to set edit link for a specific page, you can set the `editURL` parameter in the front matter of the page:

```yaml {filename="content/docs/guide/configuration.md"}
---
title: Configuration
params:
editURL: "https://example.com/edit/this/page"
editURL: "https://example.com/edit/this/page"
---
```

Expand Down
5 changes: 2 additions & 3 deletions exampleSite/content/docs/guide/configuration.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,11 @@ params:
```

将为每个页面自动生成编辑链接。
如需为特定页面设置编辑链接,可以在页面的 `front matter` 中设置 `params.editURL`:
如需为特定页面设置编辑链接,可以在页面的 `front matter` 中设置 `editURL`:

```yaml {filename="content/docs/guide/configuration.md"}
---
title: Configuration
params:
editURL: "https://example.com/edit/this/page"
editURL: "https://example.com/edit/this/page"
---
```

0 comments on commit 7772313

Please sign in to comment.