写在前面

-
-
2024-08-16

为了规范我的笔记格式,以及方便游客阅读文章(如果有的话),我把这篇文字顶置,写下我笔记的一些规范。

我尽量遵守!

结构

记录类模板

0x00 序

缘由、起因、前情提要等 + 目的  —— 做什么?

0x01  逻辑、架构等 

核心 —— 要怎么做

 · · · 过程 

过程 —— 怎么做的

0xEE 跋

总结 —— 做的怎么样

其他的东西

 手册类模板

引用:介绍是什么?

 安装

如何安装?

设置

如何设置/初始化?

使用

如何使用?

维护

如何维护?

技巧

奇技淫巧

疑难解答

常见问题或遇到的疑难问题的记录和解决

其他的东西

标题

  • 大标题标号 记录类 0x01 手册类 1、2、3
  • 二级标题标号 记录类 1、2、3 手册类 1.1、1.2、2.3

正文

 

引用

提示、警告用引用格式,

引用其他文字

链接

分为笔记内链和外链,标蓝

代码

shell

$ 表示普通用户
# 表示root用户
> 表示交互shell如数据库、Python
## 行首双井空格 表示注释内容
commone # 行末单井空格 表示注释内容

文件编辑

# /path/to/file 文件路径/名字
# ------------------------- # 与路径/名字注释同宽,用于区分文件内容
... # 表示省略内容
- aaa # 表示要替换的行
+ bbb # 表示替换的内容

ccc # 表示没有就添加、有就修改的内容,自行判断

 

“您的支持是我持续分享的动力”

微信收款码
微信
支付宝收款码
支付宝

目录