docpress-search
Search plugin for [docpress].
Last updated 5 years ago by rstacruz .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install docpress-search 
SYNC missed versions from official npm registry.

docpress-search

Search plugin for docpress.

Usage

Add me after docpress-core and before docpress-base.

How

This plugin creates/updates the following artifacts:

  • assets/search.js - JavaScript
  • _docpress.json - adds searchIndex and lunrIndex.

It takes them from all .html files (which docpress-core converted from Markdown files) with the $ attribute (assumed to be a Cheerio instance, left by docpress-core).

It also updates ms.metadata() to add assets/search.js to the js list.

It is meant to be used alongside docpress-core and docpress-base.

The frontend provides these available in the browser:

  • Search.search('keyword') - searches pages and headings
  • Search.pages - an index of all pages and headings

Current Tags

  • 0.6.0                                ...           latest (5 years ago)

1 Versions

  • 0.6.0                                ...           5 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (4)
Dev Dependencies (6)
Dependents (2)

Copyright 2014 - 2016 © taobao.org |