dbt docs generate生成文档站点如何自定义品牌及替换头部DBT logo

一、设置专属品牌标识 #

所有品牌相关的基础配置都在项目根目录的dbt_project.yml文件中完成：

• 打开dbt_project.yml，找到或新增vars配置块
• 在vars下添加dbt_docs子配置块，可按需配置以下参数：

vars:
  dbt_docs:
    # 自定义浏览器标签页显示的站点标题
    site_title: "企业数据仓库文档中心"
    # 自定义站点页脚的版权声明
    copyright: "© 2024 企业数据团队 保留所有权利"
    # 自定义站点主题主色，支持十六进制、RGB等标准颜色格式
    theme_color: "#165DFF"

如果需要自定义站点首页的介绍内容，可在项目根目录下新增docs-overview.md文件，编写符合Markdown格式的说明文本，生成文档时会自动替换默认的首页介绍。

二、替换头部默认DBT logo #

按照以下步骤操作即可替换导航栏默认logo：

• 准备好自定义logo文件，优先选择SVG或透明背景PNG格式，建议高度控制在40px左右适配导航栏尺寸
• 在项目根目录下创建assets文件夹（若已存在可跳过），将准备好的logo文件放入该文件夹，例如命名为corp_logo.png
• 回到dbt_project.yml的dbt_docs配置块中，新增logo路径配置，最终配置示例如下：

vars:
  dbt_docs:
    site_title: "企业数据仓库文档中心"
    copyright: "© 2024 企业数据团队 保留所有权利"
    theme_color: "#165DFF"
    # 配置自定义logo路径，对应assets文件夹下的文件路径
    logo: "/assets/corp_logo.png"

注意：以上配置适配dbt 1.3及以上版本，若使用更低版本可对应调整版本适配的配置规则即可。

所有配置修改完成后，重新运行dbt docs generate命令生成新的站点文件即可生效。可运行dbt docs serve本地启动预览服务，确认配置效果符合预期后再正式部署。

内容的提问来源于stack exchange，提问作者user961