没想好用什么作标题

Meshtastic China 博文撰写指南

1. 前言(Front Matter)

每篇博文应以前言部分开始,使用 YAML 格式,内容如下所示。前言部分提供了文章的元数据,必须放在 Markdown 文件的最上方。

---
title: [文章标题]
date: [YYYY-MM-DD HH:MM:SS]   # 文章发布时间
thumbnail: [缩略图链接]   # 文章的预览图像
description: [简短的文章描述,最多160字符]
categories:
 - [分类1]   # 例如:“天线”、“教程”、“固件”等
tags:
 - [标签1]   # 描述文章内容的标签
 - [标签2]
author:
  name: "[作者姓名或用户名]"   # 文章的作者
version: 1.0   # 文章版本(如适用)
---

字段说明:

  • title:文章标题。
  • date:文章发布时间,格式为 YYYY-MM-DD HH:MM:SS
  • thumbnail:缩略图的链接,可以是本地或外部的图片地址。
  • description:文章的简短描述,会显示在首页作为副标题,建议不超过160个字符。
  • categories:文章所属的分类列表,例如:“天线”、“Mesh 网络”、“教程”等。
  • tags:与文章内容相关的标签,例如:“dB”,“Mesh 网络”,“固件”等。
  • author:文章作者的姓名或用户名。
  • version:文章的版本(如适用)。

2. 文章文件夹与图片管理

所有文章的图像资源应存放在一个与文章 Markdown 文件同名的文件夹内,位置在 /source/_posts 目录下。

避免使用图床(外部图片托管服务)

  • 我们不推荐使用图床服务,尤其是免费的图床服务。此类服务不稳定,可能会定期删除图像,导致您的文章无法显示完整内容。
  • 建议将所有资产存储在本地:所有图片、截图和其他资源应保存在与文章文件同名的文件夹内,这样可以确保资源的长期可用性。

缩略图:

  • 缩略图图片应在前言部分使用相对路径或外部链接进行引用。推荐使用存储在本地的图片。
    thumbnail: ./your-post-folder/thumbnail.jpg

文章中的图片:

  • 文章中的图片应使用相对路径进行引用。如果图片存储在与 Markdown 文件相同的文件夹内,应如下引用:

    ![](./your-post-folder/your-image.jpg)
  • 禁止使用 HTML 代码来引用图片。请使用标准的 Markdown 语法,而不是 HTML 标签。

    • 正确示例:
      ![](https://example.com/path/to/image.jpg)
    • 错误示例(避免使用):
      <img src="https://example.com/path/to/image.jpg" />
  • 如果使用外部托管的图片(如果必须使用),可以使用标准的 Markdown 语法链接图片:

    ![](https://example.com/path/to/image.jpg)

3. 文章结构

撰写文章时,请遵循以下结构:

  1. 引言:
    简要介绍文章内容,阐明写作目的以及读者可以从中获得哪些信息。

  2. 正文:
    将内容分成多个清晰的小节,使用适当的标题和子标题。可以使用列表、表格或代码块来清晰呈现信息。

  3. 图片与实例:
    在文中插入相关图片和示例,确保图片与内容相关且合适地放置。

  4. 结论:
    总结文章的要点,并根据需要给出后续行动建议或读者的下一步思考。

关于标题层级的重要说明:

  • 从 H2 (##) 开始:所有标题应从 H2 (##) 开始。不要使用 H3 (###) 或更低层级的标题,除非有特别需要。

4. 前言示例与文章内容

以下是一个标准的文章示例,包含正确的前言和 Markdown 结构:

---
title: 从dB到dBm无线电信号的深入分析
date: 2024-11-28 23:15:20
thumbnail: ./dB-indicators/TITLE_DB.png
description: 作为一名无线电爱好者你必须要知道!!!
categories:
 - Antenna
tags:
 - dB
 - dBw
author:
  name: "BH4ME"
version: 1.0
---

## 介绍

在这篇文章中,我们将深入探讨无线电信号的强度单位——dB和dBm。理解这些概念对于每位无线电爱好者来说都至关重要。

## dB与dBm的区别

dB(分贝)和dBm(分贝毫瓦)是测量无线电信号强度的常用单位。二者之间存在显著差异。

### 示例图:

![](./dB-indicators/TITLE_DB.png)

## 结论

通过理解 dB 和 dBm 的区别,您将能够更准确地分析无线电信号的强度,这是每位无线电爱好者和工程师的基础知识。

在这个示例中:

  • 缩略图位于 /dB-indicators 文件夹内,并在前言部分进行了引用。
  • 文章内容中使用了相对路径引用存储在同一文件夹内的图片。

5. 格式化与常规注意事项

  • 使用 Markdown 语法:所有标题、列表和代码块都应使用 Markdown 语法(避免使用 HTML 语法)。
  • 代码块:对于命令行示例或代码段,应使用代码块格式。例如:
    # 示例命令
    $ meshtastic --help
  • 图片:在文章中插入的图片,确保使用相对路径,并存储在与文章同名的文件夹内。请勿使用 HTML 标签来插入图片。

遵循上述指南,您的文章将结构清晰,资源有序,确保发布过程顺利进行。感谢您的贡献,期待您的精彩文章!

本文作者: Hays Chan | 陈希

本文链接: https://meshcn.net/README.html