-
Notifications
You must be signed in to change notification settings - Fork 188
项目文档目录配置
Jimmy song edited this page Jul 26, 2019
·
1 revision
本文档用于说明如何为 Projects 中的文档配置目录(sidebar)。
文档的目录和顺序不通过具体文档中的weight字段指定,而由项目下的 \_index.md
内 front matter 的 sidebar 字段指定。
该字段是由两类节点组成的树状结构,使用 yaml 格式:
目录节点:
- title: 目录节点的标题
- sub: 该目录下的子目录,是一个链接节点的数组
链接节点:
- title: 链接标题
- link: 具体文档的链接,相对路径,比如 overview 就表示 /projects/project-name/overview
# 该文件是 content/zh/projects/sofa-registry/_index.md
---
draft: false
title: "SOFARegistry"
description: "SOFARegistry 是一个生产级、高时效、高可用的服务注册中心。"
github: "https://github.com/sofastack/sofa-registry"
sidebar:
- title: '产品介绍'
sub:
- title: '简介'
link: 'overview'
- title: '术语'
link: 'terminology'
- title: '快速开始'
sub:
- title: '服务端部署'
link: 'server-quick-start'
- title: '客户端部署'
link: 'client-quick-start'
- title: '开发手册'
sub:
- title: 'JAVA SDK'
link: 'java-sdk'
---
© 2019 The SOFAStack Authors