github / github/markup

Include code files

未关闭
#2,084 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Ruby
星标
6k
派生
3.4k
PR 合并指标
30 天内没有已合并 PR

描述

#1524

It would be great to have a way to include code files into README.rst. By separating the code to another file, we can do static type checking etc. on our examples to ensure they are always running correctly.

(I don't what the point of adding a stale bot is, if nobody triages the issues here...)

贡献指南

打开贡献指南

调研方向

Start by reading the referenced issue #1524 and the README.rst examples to determine the intended code-file inclusion behavior. Trace how README.rst is currently processed, then define and test a complete inclusion path whose behavior is clear for separated, statically checked examples.

由索引模型根据 Issue 内容生成。

评估

技术栈
ruby
领域
documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
活跃
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。