Skip to content

recursivelymade/externaltags.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

External Tags

This is a JSDoc's plugin to enable linking external libraries in your JS documentation.

Install the js file into your jsdoc/plugins folder and update your conf.json file with

"plugins": [
	"plugins/externaltags",
],

In your js file add @externals { "name": "jQuery", "url": "http://www.jquery.com" }

In the details template add

<?js if (data.externals && data.externals.length) { ?>
	<h2 class="subsection-title">Externals</h2>
	<ul>
	<?js data.externals.forEach(function(r) { ?>
		<li><a href="<?js= r.url ?>"><?js= r.name ?></a></li>
	<?js }); ?>
	</ul>
<?js } ?>

About

A plugin for JSDoc3 to enable external tags

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published