Documentation 编辑/管理/创建要发送给客户的静态HTML文档的最佳方法？

一段时间以来，我一直在想这个问题。我想为购买我的产品（HTML模板和Orchard主题）的客户提供顶级文档，并与他们的购买捆绑在一起

我认为最好的方法是在产品中附带一个格式良好的静态HTML站点。他们可以在自己的浏览器中本地打开它，而且它可以非常实用（粘性导航等）

目标是让他们看起来像这样：

我不想直接用HTML代码攻击我的内容，所以我想也许我应该用Markdown编写内容，然后以某种方式将它们自动转换/生成为带有导航和我的徽标等的静态站点

我已经研究过像杰基尔/海德这样的静态站点生成器，但我不愿意走这条路，因为

• a） 我在Windows8上运行，我讨厌摆弄Ruby/Python之类的东西 它的所有文档和tut都是针对Linux/Mac用户的
• b） 我想 那太过分了。特别是因为我得学一门外语 新的模板语言，如Liquid或Django模板

还有别的办法吗？也许是一个工具，它可以通过导航将降价呈现到文档中？还是我最终不得不咬紧牙关，潜入其中一个静态HTML生成器，创建自己的Jekyll模板

---

另一种选择是使用Orchard（显然我很熟悉）在我的网站上托管文档

< P>根据您的用户文档的复杂性和它们将被更新的频率，您可以考虑在DITA中编写这些文档。它是一种XML语义标记语言，专门为此目的而设计，有许多工具，包括免费的DITA开放工具包，可以用来生成HTML

DITA与降价相比有一些优势：

• 丰富的内容重用功能集，从短语级内容到主题和整个主题映射
• 很好地支持内容过滤和标记，例如，为不同平台生成不同的文档集
• 语义标记使您免受格式更改的影响，并确保所有主题的格式一致。如果格式需要更改，则无需更改内容，只需更改输出处理

---

奥托，在你的情况下，迪塔可能有点过头了。它的复杂性是有代价的，因为语言本身和用于生成可交付成果的工具都有某种学习曲线。然而，第二点实质上是减少或HTML输出与PDF.

取决于您的用户文档的复杂性以及它们将被更新的频率，您可能会考虑在DITA中编写这些文档。它是一种XML语义标记语言，专门为此目的而设计，有许多工具，包括免费的DITA开放工具包，可以用来生成HTML

DITA与降价相比有一些优势：

• 丰富的内容重用功能集，从短语级内容到主题和整个主题映射
• 很好地支持内容过滤和标记，例如，为不同平台生成不同的文档集
• 语义标记使您免受格式更改的影响，并确保所有主题的格式一致。如果格式需要更改，则无需更改内容，只需更改输出处理

---

奥托，在你的情况下，迪塔可能有点过头了。它的复杂性是有代价的，因为语言本身和用于生成可交付成果的工具都有某种学习曲线。然而，第二点是HTML输出与PDF相比大幅减少。

组成静态页面的一种非常方便的方法是类似笔记本的或两者都允许导出到（或内部使用）HTML

如果您不介意通过在线站点运行源代码，可以为您进行md->html转换

---

在我使用的windows设备上，我似乎也有Python中的markdown模块，但我不记得它是从哪里来的，也不知道您是否需要它。一个减价编译器可能只需要一个安装程序和几行脚本就可以了，另外你还可以得到一个python解释器，特别是在工具匮乏的windows机器上，这是一个非常有用的东西。

一个非常方便的组成静态页面的方法是一个类似笔记本的或两者都允许导出到（或在内部使用）（x）html

如果您不介意通过在线站点运行源代码，可以为您进行md->html转换

在我使用的windows设备上，我似乎也有Python中的markdown模块，但我不记得它是从哪里来的，也不知道您是否需要它。一个减价编译器可能只需要一个安装程序和几行脚本，而且你还可以得到一个python解释器，特别是在工具匮乏的windows机器上，这是一个非常有用的东西。

我相信这就是你想要的

从官方网站：

DocPad是下一代web架构；允许内容 通过文件系统进行管理，通过插件进行渲染，以及静态站点 生成用于在任何地方部署。它是用Node.js和 js，使其自然快速且易于扩展

您可以查看一下，以了解它与Jekyll的区别

最好的一点是它有可插入的模板机制。这意味着您可以使用任何模板引擎

有一个很好的工具可以帮助你理解静态博客是如何在短时间内完成的。

我相信这就是你想要的

从官方网站：

DocPad是下一代web架构；允许内容 通过文件系统进行管理，通过插件进行渲染，以及静态站点 生成用于在任何地方部署。它是用Node.js构建的