Skip to content

Commit

Permalink
docs: add encrypted content link desc, close #501
Browse files Browse the repository at this point in the history
  • Loading branch information
YunYouJun committed Jan 25, 2025
1 parent 0fc2adb commit 572629b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/pages/guide/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,20 @@ export default defineSiteConfig({
在对应需要加密页面的 frontmatter 中添加 `password: YourPassword` 即可。

`encrypt.enable``true`,且页面中密码 `password` 存在时,默认开启加密。

被加密的内容应在解密后动态渲染。此时无法(也不应)参与到构建流程中生成静态产物(否则会被直接看到)。
因此对于加密内容中的图片路径,总是应该使用绝对路径而非相对路径。

:::

::: en

Add `password: YourPassword` to the frontmatter of the corresponding page to enable encryption.

When `encrypt.enable` is `true`, and the password `password` exists in the page, encryption is enabled by default.

The encrypted content should be dynamically rendered after decryption.
At this time, it cannot (and should not) participate in the build process to generate static artifacts (otherwise it will be seen directly).
:::

```md
Expand Down

1 comment on commit 572629b

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Published on https://yun.valaxy.site as production
🚀 Deployed on https://6794d16d6c295d2c2449fffc--valaxy.netlify.app

Please sign in to comment.