博客写作指南
注意
本指南仅适用于 GDG Zhengzhou 官方博客的更新写作,博客基于 Hexo 搭建,并使用了 Icarus 作为主题。
文章结构
文章主要由两部分组成,即 Front-matter 和正文部分,其中 Front-matter 主要用于文章标题、书写日期、类型、摘要、标签等的声明,正文部分为文章主体部分。
Front-matter
Front-matter 是指每篇 Hexo 博客内MD格式文档头部的一串配置代码,他以---
开头、结尾。
日常文章
一篇典型的日常文章 Front-matter 如下:
1 | --- |
上述片段中涉及的 Hexo Front-matter 具体有以下用途:
代码 | 用途 |
---|---|
title | 文章标题 |
date | 编写时间(如不声明,可自动生成) |
categories | 文章分类,含此配置会被”分类”页面收录至相关分类,每篇文章仅允许一个分类 |
tags | 文章标签,含此配置会被”标签”页面收录至相关分类,每篇文章允许多个标签 |
language | 文章语言,在文章存在多语言版本时可以进行分类 |
toc | 是否开启文内目录 |
正文书写
正文部分的书写为严格匹配的 Markdown 格式,其基本语法如下:
1 | # 一级标题 |
更多更详细的语法说明请参见 Markdown 基本语法
文稿书写&发布101
- 创建本地文件,命名为XXX.md,XXX必须为英文,除了较为广泛使用的缩写(WTM etc.),尽量使用全拼,如有多个单词,请使用
_
作为连接符号,避免使用空格或其他符号。 - 严格遵守 Markdown 语法,完成正文部分的书写并保存。
- 上传文件至 GitHub 项目的
\source\_posts
处,完成发布。
注意
- 上传文件可以使用 Github 网页拖拽、Git 提交等方法完成,不限方法,选择你喜欢的即可。
- 文件上传后,需要等待45秒左右,等待 CI 完成编译方会在博客内看到新文章,编译时间通常不会超过2分钟