增加博客 - sofastack/sofastack.tech GitHub Wiki
本文说明如何在官网中新增一篇博客。
多语言支持
加入我们现在要发布一篇名为 SOFARPC 简介
的博客,该博客有中文和英文两个语言的版本。
根据要发布的博客使用的语言(中文或英文),在对应的语言目录创建(content/zh
或 content/en
)目录下创建 sofa-rpc-introduction/index.md
文件。
mkdir content/zh/sofa-rpc-introduction
mkdir content/en/sofa-rpc-introduction
touch content/zh/sofa-rpc-introduction/index.md
touch content/en/sofa-rpc-introduction/index.md
然后就可以打开刚创建的 Markdown 文档开始编辑。
Front matter
所有的博客都需要有 Front matter,使用 YAML 格式配置,其配置如下:
title: "SOFARPC 简介"
author: "SOFAStack"
authorlink: "https://www.sofastack.tech"
description: "SOFAStack projects"
weight: 1
categories: "SOFARPC"
tags: ["",""]
date: 2017-03-08T20:40:08+08:00
aliases: "/posts/xxx"
cover: ""
注意
- 其中
weight
、aliases
是可选的 -cover
是博客的头图,若使用本地图片,则图片需要跟index.md
位于同一层目录下,假如图片命名为cover.jpg
,则配置为/cover.jpg
,注意/
只是表示使用本地图片,而非相对于网站根目录的路径;也可以使用图片链接。cover 图片尺寸为 4:3,不低于 800 × 600 像素 - description 的内容是博客的摘要信息,不要超过 120 个字
其他
其他需要注意的地方:
- 静态文件如 PDF、PPT 等请使用 CDN 存储,使用链接的方式共享
- 图片请尽量压缩存储,和
index.md
放在同一级目录下,直接使用相对链接引用 - 请注意 Markdown 语法规范
预览
提交 PR 后可以通过 https://sofastack-preview.netlify.com/ 预览。