Skip to content

增加指南

Jimmy song edited this page Jul 26, 2019 · 1 revision

Guide 位于 content/{zh,en}/guides/目录下,其中每篇 guide 必须具有的 front matters 配置如下:

title: "使用 SOFAStack 快速构建微服务"
description: "本指南将基于 SOFAStack 快速构建一个微服务。"
github: "https://github.com/sofastack-guides/kc-sofastack-demo"
index: "https://raw.githubusercontent.com/sofastack-guides/kc-sofastack-demo/master/README.md"
projects: [
  {name: "SOFABoot", link: "https://github.com/sofastack/sofaboot"}, 
  {name: "SOFARPC", link: "https://github.com/sofastack/sofa-rpc"}, 
  {name: "SOFALookout", link: "https://github.com/sofastack/sofa-lookout"},
]
  • [必填] title:guide 的标题
  • [必填] description:简介
  • [选填] index:显示在 Guide 页面的远程文件地址
  • [必填] github:在 sofastack-guides 组织中的地址
  • [必填] projects:使用的开源组件

Guide 本身的 index.md 中不需要保存正文内容,只需要 front matters 配置即可

因为 Guide 页面的内容是存储在 sofastack-guides 组织下的,与官网本身代码是分开存储的,所以需要在最后网站发布的时候会被自动集成进来。

Clone this wiki locally