::: encrypt container, close #815 (#831)"},{"hash":"4d2361a7046214fe0f4e4af01831107fd00e38ad","time":1759849989000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(theme)!: add collections support (#704)"},{"hash":"086528606e95cca2264b4c8685228e490e807807","time":1757479441000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"feat(theme): add password support for post frontmatter (#689)"},{"hash":"0fd6cac57412002f4d72dc10378789b529adc357","time":1742063370000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"refactor(theme): improve types and flat config (#524)"},{"hash":"0c53be8f10bec3e943a493111b321be89a5952cf","time":1731083728000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: improve docs (#332)"},{"hash":"f69490af58d0d32d77ca109e062c702c1dfa891a","time":1723481804000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: update docs"},{"hash":"822d861daef23a289c5e7720cdd7b0beb79b60c1","time":1711040997000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: lint fix md"},{"hash":"2fb3da074776629502acf70e60da06022aa06b61","time":1710691945000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: update theme docs"},{"hash":"920d3d115723141dfa8a35ec376c8e372f188a53","time":1710362649000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: update docs"},{"hash":"ca097146cf4473f9ebfb04fe9e61708dcfd6d464","time":1709917771000,"email":"volodymyr@foxmail.com","author":"pengzhanbo","message":"docs: lint fix"}]},"autoDesc":true,"filePathRelative":"guide/features/encryption.md","headers":[],"bulletin":false}`),u={name:`encryption.md`},d={class:`code-block-title`,"data-title":`.vuepress/config.ts`},f={class:`code-block-title-bar`},p={class:`title`},m={class:`code-block-title`,"data-title":`.vuepress/config.ts`},h={class:`code-block-title-bar`},g={class:`title`},_={class:`code-block-title`,"data-title":`.vuepress/config.ts`},v={class:`code-block-title-bar`},y={class:`title`},b={class:`code-block-title`,"data-title":`.vuepress/config.ts`},x={class:`code-block-title-bar`},S={class:`title`},C={class:`code-block-title`,"data-title":`.vuepress/config.ts`},w={class:`code-block-title-bar`},T={class:`title`},E={class:`code-block-title`,"data-title":`.vuepress/config.ts`},D={class:`code-block-title-bar`},O={class:`title`};function k(c,l,u,k,A,j){let M=t(`VPIcon`),N=t(`VPLink`),P=t(`VPEncryptSnippet`);return n(),i(`div`,null,[l[17]||=o(`在本主题中，支持 全站加密 、 部分页面加密 和 部分内容加密 等多种灵活的加密方式。
提示
由于 vuepress 是静态站点，其自身限制的原因，加密 仅仅只是 看起来 看不到内容， 并且在 编译时，不再将 内容 预渲染到 html 中，但实际上 还是能够从 站点源文件 中获取到内容。 因此，不建议将 加密 功能 认为是 安全可靠的。
请尽量避免将 加密功能 应用于需要 严格保密 的内容 中。
已解锁的文章，仅在当前会话中可见。
在 主题配置中，添加 encrypt 选项。
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
encrypt: {
// more options...
}
})
})export default defineUserConfig({
theme: plumeTheme({
encrypt: {
global: true,
admin: ['123456'],
}
})
})export default defineUserConfig({
theme: plumeTheme({
encrypt: {
rules: {
// 可以是 md 文件的相对路径，对该文件加密
'前端/基础.md': '123456',
// 可以是 文件夹的路径，对该目录下所有文章加密
'/notes/vuepress-theme-plume/': '123456',
// 可以是 访问地址的请求路径，对该访问路径下所有文章加密
'/vuepress-theme-plume/': '123456',
// 可以是 具体的某个页面的请求路径，对该页面加密
'/article/f8dnci3/': '123456',
// 如果是 \`^\` 开头，则匹配该正则表达式的页面也会加密
'^/(a|b)/': '123456',
}
}
})
})encrypt.rules 的 键 将作为 匹配规则，值 将作为 该规则对应的密码，可以设置 一个或多个密码。
说明
encrypt.admin 也可用于解锁 部分加密 的页面。encrypt.admin 解锁后，被认为是管理员访问，其它未解锁页面也默认解锁。在 Markdown 文件的 Frontmatter 中，可以使用 password 设置文章的密码。
---
title: 加密的文章
password: 123456
---还可以添加 passwordHint 选项，用于设置密码提示信息。
---
title: 加密的文章
password: 123456
passwordHint: 密码是 123456
---export default defineUserConfig({
theme: plumeTheme({
markdown: {
encrypt: true,
}
})
})export default defineUserConfig({
theme: plumeTheme({
markdown: {
encrypt: {
password: 123456,
}
}
})
})使用 ::: encrypt 容器，将需要加密的内容包裹起来。 可以在容器中添加 password / pwd 属性，设置该容器的密码。 如果没有设置密码，将使用默认密码。
还可以在容器上添加 hint 属性，设置密码提示信息。
::: encrypt password="123456" hint="密码是连续的 6 位数"
这是加密的内容
:::密码仅有一个生效，不支持同时设置多个密码。
输入：
::: encrypt password="123456"
这是加密的内容
:::输出：
`,9),r(P,{data:`eJwNjTsOwlAMBO/ieou39vvYuQpKEaog0QXRIO6ebXdm7J+dx3XaZvFc3nOlwa7j/bHtwbnAFvDWQR+Y8JggA0zH7NDGGChhOrLJXsjaYa+v+lIgpAuSGMqGlCxNQ61QEKyFKjgT8vTMuf9vzbYgNg==`,hint:``,"path-locale":`/`}),l[28]||=o(`输入：
::: encrypt password="654321" hint="密码是连续的 6 位数"
这是加密的内容2
:::输出：
`,3),r(P,{data:`eJwdjDEKAzEMBP+ieousbNnWfSVc4SJwgXQX0oT8PesDLWilYb52zPOwzVrLOpkPg53z9bbtzg4WhQkvN6Sjp1qsjWVFtQqIgGuuEJ477PmRwBcQVem6gqPCSaQ4+TgaYiDkaBhFOr2H4P33B+31IIQ=`,hint:`密码是连续的 6 位数`,"path-locale":`/`}),l[29]||=o(`使用限制
对于被加密的内容，可以使用：
@[demo]() 从目录中引入的代码示例@[code]() 从目录中引入的代码片段@[code-tree]() 从目录中引入的代码树网络环境要求： 部分内容加密采用 Crypto API 实现， 因此，在 非 HTTPS 环境 下，将无法正常工作。
原始 markdown 内容首先进过 markdown 渲染为 HTML 内容后，再进行加密；传输到客户端，再进行解密渲染。 解密后的内容会被包装为一个动态的 vue 组件，html 作为 template 传给该动态组件，因此，涉及到运行时编译 template 的内容。这导致了如果启用部分内容加密功能，那么就需要将 vue 切换到 esm-bundler 版本，以支持运行时编译， 这会比默认的 runtime-only 版本性能差一些，体积也会增加。
类型： string
默认值： 'Only password can access this site'
说明：
全站加密时，提示信息。支持 HTML。如果你期望为访客提供获取密码的联系方式，你可能会需要这个配置。
类型： string
默认值： 'Only password can access this page'
说明：
部分加密时，提示信息。支持 HTML。如果你期望为访客提供获取密码的联系方式，你可能会需要这个配置。
string'Confirm'string'Enter password'import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
locales: {
'/': {
encryptButtonText: 'Confirm',
encryptPlaceholder: 'Enter password',
encryptGlobalText: 'Only password can access this site',
encryptPageText: 'Only password can access this page',
}
}
})
})