静态网站本身的表现形式由网站的内容来驱动展示,因此需要设计一套标准,让每个markdown文件的formatter来控制当前页面的展示形态。
---
title: 基本语法
pageType: home
order: 3
head:
- - meta
- name: keywords
content: Java极简教程
---
页面类型说明
# 在 Frontmatter 中通过 pageType 字段定义页面类型
pageType: home | custom | doc
| 页面类型 | 标识值 | 应用场景 |
|---|---|---|
| 首页 | home | 网站入口页面,展示概览信息 |
| 自定义页面 | custom | 关于我们、联系方式等独立页面 |
| 知识库页面 | doc | 文档、教程等需要导航和组织的内容 |
页面的默认行为
| 功能组件 | 首页 | 自定义页面 | 知识库页面 |
|---|---|---|---|
| 侧边栏(Sidebar) | ❌ | ❌ | ✅ |
| 文章大纲(Outline) | ❌ | ❌ | ✅ |
| 面包屑(Breadcrumb) | ❌ | ❌ | ✅ |
| 上下页导航(Pagination) | ❌ | ❌ | ✅ |
| 编辑链接(Edit Link) | ❌ | 可选 | ✅ |
| 更新时间(Last Updated) | ❌ | 可选 | ✅ |
formatter配置示例
---
# ============ 基础信息 ============
title: Java 基本语法 # 页面标题
order: 1 # 知识库中的排序
pageType: doc # 页面类型
colla: true # 是否折叠目录
# ============ UI 组件控制 ============
layout:
sidebar: true # 是否显示侧边栏
outline: true # 是否显示文章大纲
breadcrumb: true # 是否显示面包屑
pagination: true # 是否显示上下页导航
editLink: true # 是否显示编辑链接
lastUpdated: true # 是否显示更新时间
toc: true # 是否显示目录(Table of Contents)
root: true # 是否为根页面,作为知识库的顶层目录
# ============ SEO 配置 ============
head:
- - meta
- name: keywords
content: Java, 基本语法, 编程教程
- - meta
- name: author
content: 你的名字
---
0