网站选项

1 概述

在构建一个网站的时候, 需要配置 website 。接下来详细介绍下面的内容 :

2 project 选项

项目选项在 project 键下指定 :

_quarto.yml
project:
  type: website
  output-dir: _site
  preview:
    port: 4200
    browser: false

2.1 output-dir

输出路径, 默认是 _site 可以通过 output-dir 进行改变 :

2.2 resources

可以指定一些文件输出到构建的网站,会将路径一起复制到输出 :

2.3 预览网卡

计算机上有若干个网卡, 在预览的时候可以用选项 host 指定哪个网卡提供预览功能。 下面范例为所有网卡提供预览服务 :

_quarto.yml
project:                     
  preview:
    host: 0.0.0.0

默认情况下预览从从 3000 - 8000 随机数选择一个数给 port, 为了调试方便可以固定下来 :

_quarto.yml
project:                     
  preview:
    host: 0.0.0.0
    port: 3721

3 website 选项

网站选项在 website 键下指定

3.1 网站图标

可以使用 favicon 选项来设置网站在浏览器中的图标(图片文件), 它是网站的重要形象 :

_quarto.yml
website: 
  favicon: "/favicon.svg"

下面是网站图标在谷歌浏览器中的效果 :

3.2 site-url

网站正式发布以后, 为了让它能被搜索引擎和社交媒体更好地使用, 需要配置网站的 site-url 选项 :

_quarto.yml
website: 
  site-url: "https://www.quarto.com.cn"

在网站输出文件夹 _site 下会生成网站地图 sitemap.xml, 列出网站上所有可被搜索引擎抓取的页面 URL, 告诉搜索引擎 “网站有哪些页面”

3.3 open-graph

Open Graph(简称 og)是 Facebook 制定的一套元数据协议。 当网页被分享到社交平台(微信、飞书、Twitter、Facebook、LinkedIn 等)时, 这些平台会读取页面里 <meta property="og:xxx"> 标签, 从而在分享卡片中展示 “标题title”、“描述description”、“缩略图image”、“站点名site_name” 等信息, 而不是只显示一个 URL :

还可以单独为 open-graph 选项设置参数,不用再担心 _quarto.yml 其他部分的影响 :

_quarto.yml
website: 
  open-graph: 
    title: "OG,Quarto文档生成" 
    description: "OG,介绍如何利用 Quarto 生成文档"
    image: "/og-1200x630.png"   
    site-name: "OG,Quarto文档生成"

4 Listings 选项

Listings 是 Quarto 中最实用的 “自动目录/文章聚合” 功能 :它会读取指定目录内各 .qmd 文件的 YAML 元数据,自动生成文章卡片、表格或列表。新增文章后无需手动改首页或目录页 :

前面的范例没做任何设置, 表格被放置到了页面的末尾。 如果要放在文档的指定位置, 需要设置一个 id ,然后把 id 放在指定的位置 :

4.1 字段

如果需要表格里输出更多内容, 需要设置 fields 字段 :

4.2 风格

默认是博客风格, 还可以用 table、grid风格, 有可以自定义 :

可以使用 page-size 控制 Listing 在一页的数量 :

4.3 table增强

有两个增强 table 的设置, 鼠标触碰提示和交替颜色 :

4.4 自定义字段

可以为字段设置个性化的名字 :

5 链接