用 Markdown 编写软件教程的基础方法
快速了解标题、命令、提示和截图的组织方式。
Markdown 非常适合技术文章:源文件简单、便于备份,也可以轻松迁移到其他博客系统。
常用写法
使用二级标题拆分操作阶段,并在命令执行前说明它会做什么:
1sudo apt update
2sudo apt install caddy
命令中的文件名、按钮名或参数可以使用行内代码,例如 Caddyfile 或 --minify。
图片建议
截图建议放入 static/images/文章名称/,文章中使用如下路径引用:
1
发布前注意遮挡截图中的域名后台令牌、邮箱和公网地址等敏感信息。