livedoc 0.3.4

关于

受Concordion、Fitnesse和RobotFramework的启发，LiveDoc是一种保持文档实时更新的方法。

想法是使用文档作为测试，这样文档本身也会被测试。这样，您可以确保它始终保持更新，并向产品所有者展示精美的报告。

它是如何工作的？

LiveDoc 解析生成的 HTML，搜索一些特殊代码。您可以随意生成这种代码。

为了方便地编写 Markdown，我选择了 Concordion 的方法：通过在 title 属性中添加链接到 - 中的代码。示例

<a href=”-” title=”a = TEXT”>5</a>

这将显示值，5，作为常规的 HTML 文本，但会将文本分配给变量 a。现在您可以操作它了

<a href=”-” title=”a += TEXT”>5</a>

并检查结果

<a href=”-” title=”a == TEXT”>10</a>

或者只显示它（LiveDoc 将显示分配给 OUT 变量的任何内容）

<a href=”-” title=”OUT = a”></a>

并且您可以在其中添加文本

通过设置

但这很难编写和阅读，所以可以通过使用 Markdown 来简化

通过设置 [5](- “a = TEXT”) 的值，并添加更多的 [5](- “a += TEXT”)，它将返回 [10](- “a == TEXT)”。

此外，还可以通过将名称分配给 TESTNAME 变量来设置测试名称，将任何随后的比较作为断言分组到该测试

如果将 TESTNAME 设置为 [test name](- “TESTNAME = TEXT”)，则任何比较都将添加到该测试。

默认情况下，任何标题（h1，h2，…）都设置为测试名称。

请记住，为了使其更加简单，任何比较都是一个断言。

路线图

• 0.5.0：高级固定装置

常见问题解答

LiveDoc 支持 Python 2 吗？

不。Python 2 已过时，将于 2020 年退役，所以请继续使用 Python 3。