# hexo-tipue-search-db

> hexo plugin that generates db file for tipue search

Latest version **1.2.7** (published 2026-03-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install hexo-tipue-search-db
pnpm add hexo-tipue-search-db
yarn add hexo-tipue-search-db
bun add hexo-tipue-search-db
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.2.7 |
| Published | 2026-03-27 |
| First published | 2020-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | rqh656418510 |
| Maintainers | rqh656418510 |
| Keywords | hexo, tipue, search |

## Links

- npm: https://www.npmjs.com/package/hexo-tipue-search-db
- Repository: https://github.com/rqh656418510/hexo-tipue-search-db
- Homepage: https://github.com/rqh656418510/hexo-tipue-search-db.git
- Issues: https://github.com/rqh656418510/hexo-tipue-search-db/issues
- npm.io page: https://npm.io/package/hexo-tipue-search-db

## Dependencies (1)

- [hexo-util](https://npm.io/package/hexo-util.md) latest

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 1.2.7 (latest) — 2026-03-27
- 1.2.6 — 2021-04-06
- 1.2.5 — 2021-04-06
- 1.2.4 — 2020-01-10
- 1.2.3 — 2020-01-10
- 1.2.2 — 2020-01-09

## README

# hexo-tipue-search-db

Hexo plugin to generate db content for [Tipue Search 7.1 +](http://www.tipue.com/search/docs/?d=6)

## How to install

``` bash
$ npm install hexo-tipue-search-db --save
```

## How to configure (You can do your customization)

1. Download Tipue Search zip from [here](https://www.techgrow.cn/downloads/2021/04/tipuesearch-7.1.zip), unzip it, and copy `/tipuesearch` to your `${theme_dir}/source` (or some directory like this one)

2. Add js code in `${theme_dir}/layout/_partial/head.ejs` (or some file like this one)

```html
<link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.1/normalize.min.css">
<script src="https://cdn.jsdelivr.net/npm/jquery@3.3.1/dist/jquery.min.js"></script>

<script src="tipuesearch/tipuesearch_content.js"></script>
<link rel="stylesheet" href="tipuesearch/tipuesearch.css">
<script src="tipuesearch/tipuesearch_set.js"></script>
<script src="tipuesearch/tipuesearch.min.js"></script>
```

3. The code below creates a search box, and can be anywhere on your page. Search results are displayed in the tipue_search_content div. You can optimize it, of course.

``` html
<form>
  <div class="tipue_search_group">
    <input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><button type="submit" class="tipue_search_button"><div class="tipue_search_icon">&#9906;</div></button>
  </div>
</form>
<div id="tipue_search_content"></div>

<script>
  $(document).ready(function() {
       $('#tipue_search_input').tipuesearch();
  });
</script>
```

4. Add automatic completion function of HTML5

``` html
<form>
  <div class="tipue_search_group">
    <input type="text" name="q" id="tipue_search_input" pattern=".{3,}" list="search" title="At least 3 characters" required><button type="submit" class="tipue_search_button"><div class="tipue_search_icon">&#9906;</div></button>
  </div>
</form>
<div id="tipue_search_content"></div>

<datalist id="search">
  <option>jQuery</option>
  <option>Support</option>
  <option>Tipr</option>
  <option>Tipue</option>
  <option>Tipue Search</option>
</datalist>

<script>
  $(document).ready(function() {
       $('#tipue_search_input').tipuesearch();
  });
</script>
```

5. The configuration for tipue search

``` js
$('#tipue_search_input').tipuesearch({
        'show': 10,              // Maximum number of search records displayed per page, default: 10
        'showURL': false,        // Whether to display the URL in each search result, default: true
        'newWindow': true,       // Whether to open the page in a new browser tab when clicking search results, default: false
        'footerPages': 10,       // Maximum number of page selections displayed in the footer, default: 3
        'minimumLength': 3,      // Minimum character length in search keyword, default: 3
        'wholeWords': false,     // Whether not to use languages other than English, default: true
        'showTitleCount': false  // Whether to display the number of search results in the title of the browser tab, default: true
   });
```

## Plugin config

Default posts and pages are included in generated db file, you can exclude pages by `exclude_page: true`.

``` yml
tipue_search_db:
  exclude_page: true    # default false
```

## DB file

The default db file path is: `${blog_root}/public/tipuesearch/tipuesearch_content.js`, you can use custom file path by params `path`

``` yml
tipue_search_db:
  path: '/tipuesearch/tipuesearch_content.js'     # Custom db file path, base on directory '${blog_root}/public'
```

## Demo

- [Tipue Search Demo](https://www.techgrow.cn/search/)

## Blog

- [Hexo how to use tipue search](https://www.techgrow.cn/posts/47b23c66.html)

## Thanks For

- [Tipue Search](https://tipue.com/search/)
- [Hexo-Tipue-Search-Json](https://github.com/zhouhao/Hexo-Tipue-Search-Json)

---
_Source: https://npm.io/package/hexo-tipue-search-db · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
