开发笔记

# Md文档个人规范

Author：Earl

🔎该文档规定了个人md文档的格式，标记等内容；促进文档标准化写作和样式的随用随取

最后更新：2023-12-29

# Emoji

作为文档标记使用

  1. 文档通用型标记

    Emoji 作用说明 Emoji 作用说明
    💡 需求实现方案 🔎 备注说明
    📜 需求 💡 需求实现方案
    📌 异常/反常现象 🔑 解释处理异常/反常
    🚁 记忆点 📓 记忆要点
    📻 可扩展内容

  2. 非标题分级内容标注

    Emoji 作用说明
    ✈️ 一级目录标注
    🚊 二级目录标注
    🚕 三级目录标准

# 特殊字符

输入文本 特殊字符 说明
© © 版权
® ® 注册商标
™ ™ 商标
& & 与符号
  空格

# 参数解析

  1. 单个参数格式

    • log_format

      • 参数值: log_format name [escape=default|json|none] string ...;
      • 默认值: log_format combined "...";
      • 作用域: http
      • 配置说明：配置日志的格式

      🔎可以配置要记录的变量，如下实例所示$remote_addr是远程IP地址、$time_local是本地时间、$status是请求的状态，还有以前使用过的各种变量，貌似官网列举的变量不是全部，老师说正常的Nginx变量都可以用

      🔎日志的格式除了支持文本的方式还支持json的格式的字符串，但是nginx并不知道变量的层级关系，只会去做特殊字符的转义

      【配置实例】

      log_format combined '$remote_addr - $remote_user [$time_local] '
                    '"$request" $status $body_bytes_sent '
                    '"$http_referer" "$http_user_agent"';
      1
      2
      3

# 文档摘要栏

Author：Earl

🔎该文档规定了个人md文档的格式，标记等内容；促进文档标准化写作和样式的随用随取

Git仓库：

last update | 2023-01-14

# Typora快捷键

快捷键 作用说明
Ctrl+u 文字添加下划线
alt+shift+5 文字添加删除线
Ctrl+k 插入链接
Ctrl+shift+l 隐藏侧边栏
Ctrl+shift+k 插入代码块
Ctrl+shift+m 插入公式块
Crtl+Home 跳转文档开头
Ctrl+f 搜索文档内容
Crtl+End 跳转文档末尾
Ctrl+shift+i 插入图片
F11 切换全屏
Ctrl+/ 打开源代码编辑模式
Ctrl+h 查找替换
Tab 向后缩进
shift+tab 向前缩进
Ctrl+t 插入表格
Ctrl+shift+q 生成说明栏
Ctrl+b 粗体文字
Ctrl+i 斜体文字
Ctrl+# #表示大键盘数字，转换成#级标题
Ctrl+Enter 光标在表格中使用此快捷键快速在光标下方插入行

# Typora文档样式

# 无序列表

在段落头部输入**+，然后点击空格**

  • 一级无序列表
    • 二级无序列表
      • 三级以及多级无序列表

# 有序列表

在段落头部输入1.，然后点击空格

  1. 样式示例

# 复选框

  • [ ] 在段落头部输入+ [ ]，会生成可选中选框，必须严格输入+空格[空格]空格，否则会变成无序列表
    • [x] 可以缩进使用

# 脚注

# 文字样式

  1. 输入**，星号间的文字将会展现为斜体

  2. 输入****，四个星号最中间的文字将会展现为粗体

  3. 输入******，六个星号最中间的文字将会展现为***斜体加粗***

  4. 输入~~，波浪线中间的文字将会展现为~下标~

  5. 输入~~~~，四个波浪线最中间的文字将会展现为删除线

  6. 输入^^，尖号之间的文字将会展现为^上标^

  7. 输入====，四个等号之间的文件将会高亮展现==key==

  8. 文字头部输入#，并点击空格，井号+空格后面字体将会整体展现为标题【独占行为标题】或者大好字体一号字体【非独占行为大好字体】

    🔎几级标题或者小号字体就输入几个井号，最多可以输入6个井号

  9. 输入~~~，生成代码块

  10. 输入$$，点击回车，生成公式块

  11. 输入>，点击空格生成说明栏

  12. 输入\，转义字符可以对emoji和特殊字符进行转义，直接输出文本，不再转换为对应效果，如🔎

# 代码

  1. 单行代码

    • 输入``，在中间写入单行代码
    • 样式示例：import com.atlisheng.array.ArrayList;

  2. 代码块

    • 输入```，在后面紧跟代码语言种类并回车

    • 样式示例

      public static void main(String[] args){
    show();
}
      1
      2
      3

# 分割线

  1. 输入三个连续减号就会生成分割线

    🔎可以单独成行，也可以搭配其他样式使用

# 文档目录

  1. 输入[toc]，自动生成文档目录

[toc]

Md文档个人规范
编程导航   |