You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在GitHub Markdown中实现类似Python文档的Doctest便捷复制功能?

在GitHub Markdown中优化Doctest代码复制体验的方案

GitHub原生的Markdown渲染器不支持像Python官方文档那样的“隐藏提示符和输出”按钮,但可以通过以下几种方式优化复制体验:

1. 分开展示纯代码与Doctest块

  • 优先提供不带交互式提示符和输出的纯Python代码块,方便用户直接复制使用:
    def add(a, b):
        return a + b
    
  • 再附上带Doctest格式的代码块,用于展示可直接运行的测试用例:
    >>> def add(a, b):
    ...     return a + b
    ...
    >>> add(2, 3)
    5
    

2. 用注释标记可复制区域

在Doctest代码块内,用清晰的注释标出可复制的核心代码部分,用户复制后只需剔除提示符、输出和注释即可:

# --- 可复制代码 ---
def add(a, b):
    return a + b
# --- 测试用例 ---
>>> add(2, 3)
5

3. 使用代码块折叠功能

GitHub支持在Markdown中用<details>和<summary>标签实现内容折叠,你可以把带提示符的Doctest测试用例折叠起来,只展示纯代码:

查看Doctest测试用例
>>> def add(a, b):
...     return a + b
...
>>> add(2, 3)
5

内容的提问来源于stack exchange,提问作者Frank Meulenaar

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.19 16:03:22