文档

Markdown 工具箱

面向个人用户的干净可移植 Markdown 产出工具。核心能力:. 适用于需要markdown toolkit相关能力的开发场景,包含结构化的工作流程和可复用的模板,帮助用户快速完成任务并保持代码质量. 适用于需要markdown toolkit相关能力的开发场景,包含结构化的工作流程和配置指引. 该工具经过深度差异化处置,针对用户反馈和使用痛点进行了调优改进,提升了实用性和可操作性.

它能做什么

技能文档

Markdown 工具箱（免费版）

概述

本工具生成干净、可移植的 Markdown，避免平台专有语法，保证在 GitHub、GitLab、Obsidian、VS Code 等环境一致渲染。免费版覆盖代码块语言标注、表格语法、标题层级、链接规范与单文件校验.

核心能力

能力	说明	免费版范围
可移植性	避免专有语法	全覆盖
代码块	语言标注与围栏	全覆盖
表格	标准 GFM 表格	全覆盖
标题层级	单一 H1、不跳级	全覆盖
链接	相对路径与锚点	全覆盖
技术实现要点：核心能力基于`input_params`参数与`output_format`配置实现,支持创建/查询/修改/删除等操作模式,通过`config_options`进行运行时配置.

核心功能执行

用input_params参数进行配置.

处理: 解析核心功能执行的输入参数,完成核心逻辑,返回结构化响应. 输出: 返回核心功能执行的响应数据,包含状态码、结果和日志.

执行此能力时使用input_params参数,支持创建/查询/导出操作

参数配置与调用

用config_options参数进行配置.

处理: 解析参数配置与调用的输入参数,完成核心逻辑,返回结构化响应. 输出: 返回参数配置与调用的响应数据,包含状态码、结果和日志.

执行此能力时使用config_options参数,支持修改/重置/导入操作

结果处理与输出

用output_format参数进行配置.

处理: 解析结果处理与输出的输入参数,完成核心逻辑,返回结构化响应. 输出: 返回结果处理与输出的响应数据,包含状态码、结果和日志.

执行此能力时使用output_format参数,支持导出/保存/转换操作 能力覆盖范围：本skill的核心能力覆盖以下场景关键词：面向个人的干净可、Markdown、生成工具、兼容多平台、面向个人用户的干、净可移植、避免平台专有语法、保证可移植、代码块语言标注与、表格语法规范、单文件、输出与基础校验、标题层级与链接规等。这些关键词对应description中声明的使用场景,均已在上述能力点中提供对应的操作支持.

使用场景

场景一：代码块规范

# 在此执行相关操作
echo "操作完成"
```python
# 标注语言，启用高亮
def hello(name: str) -> str:
    return f"Hello, {name}"
```bash
# 在此执行相关操作
echo "操作完成"

场景二：表格语法

| 列1 | 列2 | 列3 |
|:-----|:-----|:-----|
| 左对齐 | 居中 | 右对齐 |

场景三：标题与链接

# 文档标题（唯一 H1）
# ...
## 不适用场景
# ...
以下场景Markdown 工具箱不适合处理：
# ...
- 无明确技术栈的模糊需求
- 纯架构设计决策
- 运维部署管理
# ...
## 触发条件
# ...
需要代码生成、编程辅助、调试测试、开发部署时使用。不适用于非本工具能力范围的需求.
# ...
## 章节
# ...
### 子章节
# ...
[相对链接](./other.md)
[锚点链接](#章节)

快速开始

描述要生成的文档内容.
工具按可移植性规则生成 Markdown.
校验标题层级与代码块语言.
输出单文件.

示例

可移植性规则速查：

规则	说明
单一 H1	每文件仅一个一级标题
不跳级	H1→H2→H3，不跳 H1→H3
代码块标注	```后必标语言
表格分隔行	`
链接相对	内部链接用相对路径

优秀实践

避免专有语法：别用 ![[wiki-link]]、> [!callout] 等平台语法.
代码块标语言：``` 后写语言名，启用高亮.
表格别太宽：超 5 列考虑改列表或分表.
标题不跳级：H2 下直接 H4 会破坏目录结构.
链接用相对：内部链接相对路径，便于迁移.

常见问题

Q1：能生成多文件站点吗？ A：免费版聚焦单文件。多文件站点与目录生成为专业版能力. Q2：Mermaid 图表支持吗？ A：支持标准 Mermaid 代码块，但部分平台不渲染. Q3：脚注可移植吗？ A：GFM 脚注多数平台支持，但并非全平台兼容，谨慎使用. Q4：免费版有校验工具吗？ A：有基础校验（标题层级、代码块语言）. Q5：HTML 内联可以用吗？ A：尽量避免，HTML 在部分 Markdown 渲染器不显示.

进阶用法

代码块语言标注全集

# 在此执行相关操作
echo "操作完成"
```bash      # Shell 命令
```python    # Python
```javascript # JavaScript
```json      # JSON
```yaml      # YAML
```text      # 纯文本（无高亮）
```mermaid   # 流程图
```sql       # SQL

表格进阶

echo "操作完成"

<!-- 对齐控制 -->
| 左对齐 | 居中 | 右对齐 |
|:---:|:---:|:---:|
| A      |  B   |      C |
# ...
<!-- 宽表改列表（超 5 列） -->
- **字段1**: 说明
- **字段2**: 说明

链接与图片规范

echo "操作完成"

<!-- 相对链接（内部） -->
[文档](./guide/getting-started.md)
# ...
<!-- 锚点链接（同页） -->
[章节](#代码块语言标注全集)
# ...
<!-- 图片必加 alt -->
![架构图](./images/arch.png)
# ...
<!-- 图片加尺寸（部分平台支持） -->
![架构图](./images/arch.png =800x400)

可移植性禁忌

禁忌	后果	替代
`![[wiki-link]]`	仅部分平台支持	标准 `[text](path)`
`> [!callout]`	Obsidian 专有	标准 `>` 引用
内联 HTML	部分渲染器不显示	纯 Markdown
`~~删除~~`	部分平台不支持	谨慎使用
脚注 `[^1]`	非全平台兼容	文末标注

写作规范

标题层级递进：H1→H2→H3，不跳级.
段落空行：段落间空一行，段内不空行.
列表一致：同列表符号统一（- 或 *）.
代码块必标语言：``` 后写语言名.
链接可读：链接文本有意义，别用「点击这里」.

校验清单

[ ] 仅一个 H1
[ ] 标题不跳级
[ ] 代码块标注语言
[ ] 表格分隔行完整
[ ] 图片有 alt
[ ] 内部链接相对路径
[ ] 无平台专有语法
[ ] 列表符号统一

依赖说明

运行环境

Agent 平台: 支持SKILL.md的任意AI Agent（Claude Code / Cursor / Codex / Gemini CLI 等）
操作系统: Windows / macOS / Linux

依赖详情

依赖项	类型	是否必需	获取方式
markdownlint	校验工具	推荐	`npm install -g markdownlint-cli`
LLM API	API	必需	由 Agent 内置 LLM 提供

API Key 配置

本工具为纯 Markdown 指令，无需额外 API Key

可用性分类

分类: MD+EXEC（Markdown 指令 + 命令行校验）
说明: 通过自然语言指令驱动 Agent 生成并校验 Markdown

错误处理

错误场景	原因	处理方式
配置错误	参数缺失或格式错误	检查依赖说明中的配置要求
运行时错误	运行环境不满足	确认运行环境符合依赖说明
网络错误	连接超时或不可达	执行ping命令测试网络连通性,检查防火墙和代理设置连接后执行ping命令测试网络连通性,检查防火墙和代理设置连接后重新执行命令，参考国内替代方案

已知限制

需LLM支持,无LLM环境不可用
复杂业务场景建议结合人工经验判断
执行效率受模型能力与网络环境影响
当前为免费版本,如需完整功能请升级到付费版获取全部能力

输出格式

{
  "success": true,
  "data": {
    "result": "Markdown 工具箱处理结果",
    "execution_time": "0.5s",
    "metadata": {
      "version": "1.0",
      "processor": "markdownkit"
    }
  },
  "execution_log": ["解析输入参数", "执行核心处理", "格式化输出结果"],
  "error": null
}