Skip to content

CNB/W3C

VuePress Theme Plume

一个简约易用的,功能丰富的 vuepress 文档&博客 主题

功能

内置丰富的功能,满足网站一般需求。

  • 文章信息

    为文章添加标签、分类、字数统计、阅读时间、写作日期等信息。

  • 评论

    支持 4 种评论系统:Giscus、Waline、Twikoo、Artalk
    你可以自由选择符合你的需求的评论系统。

  • 搜索

    支持基于 minisearch 的本地搜索,还支持接入 Algolia 搜索。

  • 加密

    支持全站加密、部分加密(加密目录、加密文章)。

  • 代码

    代码复制,CodePen演示,JSFiddle演示,CodeSandbox演示,代码组,行高亮,行聚焦,行警告,差异对比,代码块折叠等。

  • 资源嵌入

    图表:chart.js/ECharts/Mermaid/flowchart
    视频:Bilibili/Youtube/ArtPlayer
    PDF,200K+ Iconify 图标

博客

主题默认支持博客,生成你的个人博客。

  • 文章列表

    通过文章写作日期,自动排序并生成博客文章列表页。

  • 博主信息

    自定义名称、座右铭、头像,社交媒体链接。

  • 分类、标签、归档

    自动生成分类页、标签页,为文章根据年份进行归档。

文档

主题默认支持文档,生成你的产品文档,或归纳你的知识体系。

  • 侧边栏

    根据文档目录自动生成侧边栏,也可以手动配置,主题提供了更简单的配置方式。

  • 文档分类归纳

    可以文档的不同,归纳到不同的目录,更好的管理文档结构。


1.在CNB&EdgeOne-Pages中使用

CNBfork本项目到自己的组织仓库下。

2.创建一个EdgeOne-Pages项目:

创建的时候选择直接上传的方式

3.获取API token

pages里面创建API Token

4.之后在CNB中新建一个密钥仓库

在密钥仓库里增加一个文件,此文件用来存pages的API Token,文件后缀是ymlenvs.yml

envs.yml文件内容为:

EDGEONE_PAGES_API_TOKEN: 将API token粘贴替换到此处

API token保存完之后复制这个文件envs.yml的地址

在回到第一步你fork的这个仓库,点击开.cnb.yml文件,替换刚才复制的envs.yml文件地址到.cnb.yml的第6/15行。

.cnb.yml示例:

main:
  push:
    - runner:
        cpus: 64
      # 下面的地址替换成你创建的密钥文件envs.yml的地址
      imports: https://cnb.cool/w3c/env/-/blob/main/envs.yml
      stages:
        - name: 云原生构建并部署到pages
          image: node:20
          jobs:
          - name: 构建网站文件
            script: npm install && npm run build
          - name: 发布到Pages中
            # 下面这一行 --name 后面修改pages项目的名字
            script: node_modules/.bin/edgeone pages deploy ./.vitepress/dist --name 替换项目(pages)的名字 --token $EDGEONE_PAGES_API_TOKEN

参考文档