模拟Ext JS 4文档

Question

我一直在研究我们产品的各种文档选项。我认为拥有Ext JS 4 Docs类型的外观和感觉而不是Twiki会很酷。

但我很难理解Ext JS 4.0.7中的当前文档页面。每个目录都有README.js＆amp; README.md。如果我没有错，我必须在README.md中创建自定义文档，但我无法理解如何将其转换为README.js。

有人可以告诉我如何将.md文件转换为.js吗？

Answer 1

他们使用自制工具，称为JSDuck

我猜你需要在你的.md文件上运行它，它会为你生成.js文件。

Answer 2

JsDuck是要走的路。我正在使用它来构建一些自定义文档。

获取指南：

1. 只需创建一个json文件。我通常称它为guides.json并写出结构。它在下面的链接中有明确定义。

2. 在与指南文件相同的位置创建一个文件夹，并在其中：

   • 为json中的每个条目创建一个文件夹。 （每个条目都有一个名称字段，这应该是文件夹的名称）
   • 创建文件readme.md
   • 为其添加图标。它应该是名称icon-lg.png

3. 从命令行使用jsduck时，请将以下内容添加到参数中：

   --guides=[the path to your guides.json file]
   

可在此处找到更多信息： https://github.com/senchalabs/jsduck/wiki/Advanced-Usage（转到指南部分）

另外，要获取有关命令行参数的更多信息，请使用命令

jsduck-3.2.1 --help=full

希望这适合你。