widmogrod/run-the-docs

保持代码和文档同步。在浏览器中运行代码示例

维护者

详细信息

github.com/widmogrod/run-the-docs

源代码

问题

安装: 13

依赖项: 0

建议者: 0

安全: 0

星标: 1

关注者: 2

分支: 0

开放问题: 1

dev-master 2017-12-28 21:33 UTC

Requires

Requires (Dev)

MIT c2d92193c5c2c28acba297ef2812f78ca3935d2a

  • widmogrod <widmogrod.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-07 18:16:39 UTC

README

简介

保持代码和文档同步。在浏览器中运行代码示例。

规格（草案）

核心概念

  • 语言无关。 从任何编程语言生成文档。
  • 代码即文档。 将文档内联在代码中，使其更容易与代码库的实际状态保持同步。
  • 示例即测试。 将示例作为测试可以保护它们免于过时，因此保护文档免于过时。