Макет документации Ext JS 4 - PullRequest
Новая
       3

Макет документации Ext JS 4

4 голосов
/ 23 декабря 2011

Я искал различные варианты документации для наших продуктов. Я подумал, что было бы здорово иметь Ext JS 4 Docs тип внешнего вида, а не Twiki.

Но мне нелегко разобраться с текущей страницей документации в Ext JS 4.0.7. У каждого каталога есть README.js & README.md. Если я не ошибаюсь, мне нужно создать свою пользовательскую документацию в README.md, но я не понимаю, как это будет преобразовано в README.js.

Может кто-нибудь дать мне знать, как .md файл можно преобразовать в .js?

Ответы [ 2 ]

2 голосов
/ 23 декабря 2011

Они используют самодельный инструмент, который называется JSDuck

Я думаю, вам нужно запустить его поверх ваших файлов .md, и он сгенерирует файлы .js для вас.

1 голос
/ 28 декабря 2011

JSDuck это путь.Я использую его для создания какой-то пользовательской документации.

Чтобы получить направляющие:

  1. , просто создайте файл json.Я обычно называю это guides.json и выписываю структуру.Это хорошо определено в ссылке ниже.

  2. Создайте папку в том же месте, что и файл направляющих, и в нем:

    • создайте папку для каждой записи в json.(каждая запись имеет поле имени, и это должно быть имя папки)
    • Создать файл readme.md
    • Добавить значок к нему.Это должны быть имена*

      Дополнительную информацию можно найти здесь: https://github.com/senchalabs/jsduck/wiki/Advanced-Usage (перейдите в раздел руководств)

      Кроме того, для получения дополнительной информации о параметрах командной строки используйте команду 

      jsduck-3.2.1 --help=full

      Надеюсь, это работает для вас.

...