CODEWITHSUNDEEP
extjs4extjs
shafi khan
shafi khan

Reputation: 85

Mock of Ext JS 4 documentation

I have been researching for various type of documentation options for our products. I thought it would be cool to have Ext JS 4 Docs type of look&feel rather than Twiki.

But I am having tough time to understand the current docs page in Ext JS 4.0.7. Each and every directory has README.js & README.md. If I am not wrong, I have to create my custom documentation in README.md, but I am failing to understand how that would be converted into README.js.

Could someone let me know how to .md file can be converted into .js?

Upvotes: 4

Views: 675

Answers (2)

ritcoder
ritcoder

Reputation: 3304

JsDuck is the way to go. I'm using it to build some custom documentation.

To get the guides:

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

  2. Create a folder in the same location as the guides file and in it:

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

  3. When using jsduck from the command line, add the following to the 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 guides section)

Also, to get more information on the commandline parameters, use the command

jsduck-3.2.1 --help=full

Hope this works for you.

Upvotes: 1

Demnogonis
Demnogonis

Reputation: 3222

They are using a self made tool, which is called JSDuck

I guess you need to run it over your .md files and it will generate the .js files for you.

Upvotes: 2

Related Questions