help log2md_cn 英文版本

标题

log2md - 生成带有自定义功能（如标题、代码块包裹）的 Markdown 格式日志。

语法

log2md filename [, replace append title(string)]

选项

Main Options

replace 如果文件已存在，覆盖现有文件，不能与 append 一起使用。

append 将新内容附加到现有文件，不能与 replace 一起使用。

title(string) 为日志文件添加自定义标题。string 是用户定义的标题。

描述

log2md 命令生成 Markdown 格式的日志文件，所有命令输出都包装在代码块中，适合在 Markdown 平台（如 GitHub 或 Jupyter Notebooks）中阅读和共享。

通过该命令，用户可以轻松记录日志内容，包括自定义标题、时间戳和日志模式（替换或追加）。

使用说明

- 日志文件以 Markdown 格式创建，包含时间戳、标题等信息，内容被包装在代码块中。

- log close 用于关闭日志文件，完成写入操作。

- 如果未指定 replace 或 append，默认使用 replace 格式。

- 使用 append 时，指定的文件必须存在，否则会报错。

- 分隔符默认为 `---`，相当于 Markdown 的分隔线。

- log2md进行代码块包裹的逻辑为：在进行自定义标题等输入后，将默认以分隔符`---`对log工作日志进行分隔。

- 并在起始位置以“```”作为标志，对log日志内容进行代码块包裹，以log close表示关闭日志。

- 当采用append选项追加时，将自动检查，对上一次log日志进行代码块包裹结束补齐。

- 采用replace选项时，代码块包裹将只有起始位置有“```”

Examples

Examples 1 - 创建一个新日志文件并使用自定义标题：

log2md mylog.md, replace title("我的分析")

sysdir

sysuse auto, clear

describe

log close

- 下述open2命令需要进行下载，当然你也可以手工打开该Markdown文件

open2 mylog.md

shellout mylog.md

Examples 2 - 将新内容附加到现有日志文件.

log2md mylog.md, append title("附加结果")

set more on

set more off

dir

sysdir

- 下述open命令需要进行下载。open命令可以列出并打开当前工作路径，并将当前工作目录的路径复制到系统剪贴板

sysuse auto, clear

open

log close

open2 mylog.md

Author

Wang Qiang , Xi’an Jiaotong University, China.

E-mail: 740130359@qq.com.

also see

Help:cnuse, topsis