VVCMS5 Logo
首页 / 开发文档 / 主题开发
主题开发

主题开发:开发规范与目录约定

主题目录结构、命名规范、可维护性约定与常见拆分方式。

2026-03-04 0

目标

主题开发的核心目标是:结构清晰、可复用、可维护、可迭代。建议你从现有主题复制一份开始改,避免从零搭建遗漏细节。

1. 目录结构建议

my-theme/
├── info.json
├── vvdata.json
├── init_data.json
├── views/
│   ├── index.html
│   ├── category.html
│   ├── article.html
│   ├── page.html
│   ├── message.html
│   ├── docs.html
│   ├── docs-article.html
│   ├── header.html
│   ├── footer.html
│   ├── sidebar.html
│   └── js.html
└── static/
    ├── css/
    ├── js/
    └── images/

2. 命名规范

  • 模板文件使用 kebab-case(例:docs-article.html
  • 栏目/内容 slug 使用英文小写 + 中划线,避免频繁变更
  • 公共片段模板:header/footer/sidebar/js 等保持稳定

3. 模板拆分建议

  • 不要把所有内容塞进 index.html/article.html
  • 复杂区块抽成独立 partial(例如卡片组件、列表项组件)
  • 统一入口:header.html 引入导航、footer.html 放全站链接

4. 可维护性约定

  • 尽量用栏目 slug 驱动,不要在模板里写死太多链接
  • 保持样式体系一致(Tailwind 约定、间距/颜色复用)
  • 对“数据结构/字段”做兼容处理(字段缺失时降级显示)