https://github.com/haochi/jsdoc-search

Search plugin for JSDOc
https://github.com/haochi/jsdoc-search

Last synced: about 9 hours ago
JSON representation

Search plugin for JSDOc

• Host: GitHub
• URL: https://github.com/haochi/jsdoc-search
• Owner: haochi
• License: mit
• Created: 2015-05-15T10:10:33.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-05-15T10:54:41.000Z (over 9 years ago)
• Last Synced: 2023-03-15T22:10:32.208Z (over 1 year ago)
• Language: JavaScript
• Homepage: http://ihaochi.com/jsdoc-search/demo/
• Size: 508 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
JSDoc Search Plugin

-------------------

Demo

====

[Demo](http://ihaochi.com/jsdoc-search/demo/)

Usage:

======

* Download all the files

* Update your JSDoc configuration file (e.g. `conf.json`) to include the plugin and configure the templates.

		{

		    "plugins": ["./search/search"],

		    "templates": {

		        "default": {

		            "layoutFile": "./search/layout.tmpl",

		            "staticFiles": {

		                "include": [

		                    "./search/statics"

		                ]

		            }

		        }

		    }

		}

If you are using a custom layout, you can copy the appropriate changes from `layout.tmpl` to your layout.