All geek questions in one place

Ext JS 4 Documentation Layout

I studied various types of documentation for our products. I thought it would be great to have Ext JS 4 Docs look & feel, not Twiki.

But it's hard for me to find the current doc page in Ext JS 4.0.7. Each directory has README.js and README.md. If I am not mistaken, I need to create my user documentation in README.md, but I do not understand how this will be converted to README.js.

Can someone let me know how a .md file can be converted to .js ?

+4
source share
2 answers

They use a makeshift tool called JSDuck

I think you need to run it on top of your .md files, and it will generate .js files for you.

+2
source

JsDuck is the way to go. I use it to create custom documentation.

To get a guide:

  • just create json file. I usually call it guide.json and write out the structure. It is well defined in the link below.

  • Create a folder in the same place as the manual file and in it:

    • create a folder for each json entry. (each entry has a name field, and this should be the name of the folder)
    • Create readme.md file
    • Add an icon to it. These must be the names icon-lg.png

  • When using jsduck from the command line, add the following arguments:

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

More information can be found here: https://github.com/senchalabs/jsduck/wiki/Advanced-Usage (go to the manuals section)

Also, for more information about command line options, use the command

 jsduck-3.2.1 --help=full

Hope this works for you.

+1
source

Source: https://habr.com/ru/post/1387717/

More articles:


All Articles