search

angular / material

Material design for AngularJS
https://material.angularjs.org/
MIT License
16.54k stars 3.39k forks source link

docs: create a Dash docset for AngularJS Material #8165

Open ThomasBurleson opened 8 years ago

ThomasBurleson commented 8 years ago

Useful to integrate online docs into WebStorm and Dash

ThomasBurleson commented 8 years ago

This will be a fun and really cool feature. Here are Docset viewers for:

TareqElMasriDev commented 8 years ago

Agreed.

keeprock commented 7 years ago

@ThomasBurleson is there any updates on this awesome feature? I would like to contribute on this if there are any work already done. Because I want to use it myself.

As I heard, team more focused on delivering Angular Material 2, so this feature not high priority right now, I guess. Which is kind of sad thing, because offline-docs are really helpful. With an addition of some hot-keys in IDE. It really makes development easier and faster.

devversion commented 7 years ago

@keeprock I didn't start with that yet but I'd be happy to let others work on this.

Splaktar commented 4 years ago

https://github.com/technosophos/dashing seems promising. I tried it out with a bare minimum configuration and it sort of worked.

The main effort to get this working seems to be mapping these selectors to the proper "Entry Types":

{
  "name": "AngularJS Material",
  "package": "angularjs-material",
  "index": "index.html",
  "selectors": {
    ".api-profile-header h2": "Section",
    ".api-params-item": "Parameter",
    ".api-type": "Type",
    "title": "Package"
  },
  "ignore": [],
  "icon32x32": "../AngularJS-Material-Icon-32x32.png",
  "allowJS": true,
  "ExternalURL": "https://material.angularjs.org"
}

But even then, it seems like it needs pre-rendered, static docs to process, otherwise you get a lot of {{currentDoc.name}} API Documentation entries.

Another approach is to use https://github.com/theasta/jsdoc-dash-template to generate the docset from our JSDoc. However, when I tried that it was clear that it doesn't understand Markdown (links, back ticks, etc) in JSDoc comments or any of the dgeni custom code that we rely upon.