[wp-meta] [Making WordPress.org] #3063: Show JavaScript documentation on developer.wordpress.org
Making WordPress.org
noreply at wordpress.org
Tue Dec 18 12:38:52 UTC 2018
#3063: Show JavaScript documentation on developer.wordpress.org
---------------------------+---------------------
Reporter: atimmer | Owner: (none)
Type: enhancement | Status: new
Priority: normal | Milestone:
Component: Developer Hub | Resolution:
Keywords: |
---------------------------+---------------------
Comment (by herregroen):
Regarding parsing the jsdoc using the JSDoc template I've created you can
use the following JSDoc template with Gutenberg. This expects the jsdoc-
parser to be located on the same level as the gutenberg directory.
jsdoc.conf.json:
{{{#!json
{
"plugins": [],
"recurseDepth": 10,
"source": {
"include": ["packages/"],
"exclude": [],
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "((^|\\/|\\\\)_|node_modules)"
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"templates": {
"packages": true,
"packagesRoot": "packages/"
},
"opts": {
"template": "../jsdoc-parser",
"recurse": true
}
}
}}}
Running jsdoc with that configuration ( `jsdoc -c jsdoc.conf.json` ) will
generate a `parsed-jsdoc.json` file that can be imported using
https://github.com/WordPress/phpdoc-parser with the `wp parser import`
command.
This will generate posts in exactly the same manner as is already done for
the PHP.
It should be noted that as mentioned above there's a few things lacking in
both that plugin as well as the `wporg-developer` theme that would need to
be addressed.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/3063#comment:5>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list