Cloud-Link's blog Cloud-Link's blog
首页
  • 开发资源
  • 人员动态
  • 新人训练
  • 奖惩通报
  • 通讯录
项目资产
  • 快速指南
  • 后端框架
  • 前端框架
  • 业务模块
  • 基础理论
    • 前端
    • 后端
    • 数据库
    • 工具类
  • 常用
  • 网站
  • 资源
  • Vue资源
  • 分类
  • 标签
  • 归档
关于
首页
  • 开发资源
  • 人员动态
  • 新人训练
  • 奖惩通报
  • 通讯录
项目资产
  • 快速指南
  • 后端框架
  • 前端框架
  • 业务模块
  • 基础理论
    • 前端
    • 后端
    • 数据库
    • 工具类
  • 常用
  • 网站
  • 资源
  • Vue资源
  • 分类
  • 标签
  • 归档
关于
  • 前端

  • 后端

  • 数据库

  • 工具类

    • Vepress

      • 介绍
      • 快速上手
      • 目录结构
      • 核心配置和约定
      • 文档编写和一级标题
      • 自动生成front matter
      • 批量操作front matter工具
      • Markdown 容器
      • Markdown使用教程
      • Markdown 中使用组件
      • 提高文档表现力
    • Git

    • npm

  • Vue

  • TypeScript

  • React

  • 知识库
  • 工具类
  • Vepress
2021-06-18

文档编写和一级标题

写文档时,大概的流程是这样的:

1.首先是创建.md文件,如果在结构化目录下则需要添加相应的序号,在碎片化博文目录_posts下不需要添加序号,文件名填写文档的标题。

2.如果你想手动指定文档的分类、标签,则需要在头部front matter填写相应的字段。一般情况下不需要再填写其他字段。不想手动指定分类和标签也可以省略这一步。

---
categories: 
  - 分类1
tags: 
  - 标签1
  - 标签2
---
1
2
3
4
5
6
7

3.关于一级标题,即markdown中的一级标题(# 标题),你可以写也可以不写,在页面中实际显示的文档标题是取自front matter中的title,然后把.md中的一级标题隐藏了。

这样做即可以保留本地文件的一级标题,也可以兼容线上页面的标题。 同时,对于在新建.md文件时已经输入了一次标题在文件名,不想在文档中重复输入一次标题的,也是可以实现的。

4.关于文档摘要,你想在首先文档列表中显示摘要时可以在合适的位置添加一个<!-- more -->注释,参考:添加摘要

5.最后,就可以正式开始写作啦。

核心配置和约定
自动生成front matter

← 核心配置和约定 自动生成front matter→

Copyright © 2021-2022 用技术改变世界 | Tungray Cloud-Link
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×