npmpackage.info

Gathering detailed insights and metrics for hexo-generator-searchdb

Other packages similar to hexo-generator-searchdb

hexo-generator-tag

2.0.0

Tag generator for Hexo.

hexo-generator-category

2.0.0

Category generator for Hexo.

hexo-generator-archive

2.0.0

Archive generator for Hexo.

hexo-generator-index

4.0.0

Index generator for Hexo.

Gathering detailed insights and metrics for hexo-generator-searchdb

hexo-generator-searchdb

🔍 Seach data generator plugin for Hexo.

1.4.1

MIT

JavaScript

532,656 3.9

Installations

npm install hexo-generator-searchdb

Score

76.8

Supply Chain

93.8

Quality

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

3

Total

25

Closed

8

Merged

14

Issues

Open

6

Total

13

Closed

7

Releases

v1.4.1

Published on 27 Dec 2022

View all 1 releases

Developer

next-theme

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

18.11.0

NPM Version

8.19.2 Statistics

69 Stars

53 Commits

5 Forks

2 Watching

3 Branches

9 Contributors

Updated on 13 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

532,656

Last day

6.7%

538

Compared to previous day

Last week

2,909

Compared to previous week

Last month

4.1%

12,561

Compared to previous month

Last year

63.4%

151,191

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

nunjucks

Dev Dependencies

@next-theme/eslint-config eslint

Versions

hexo-generator-searchdb

Seach data generator plugin for Hexo.

This plugin is used for generating a search index file, which contains all the necessary data of your articles that you can use to write a local search engine for your blog. Supports both XML and JSON format output.

Install

size-image

1npm install hexo-generator-searchdb

Options

You can configure this plugin in your root _config.yml. All the arguments are optional.

1search:
2  path: search.xml
3  field: post
4  content: true
5  format: html

path - file path. By default is search.xml. If the file extension is .json, the output format will be JSON. Otherwise XML format file will be exported.
field - the search scope you want to search, you can chose:
- post (Default) - will only cover all the posts of your blog.
- page - will only cover all the pages of your blog.
- all - will cover all the posts and pages of your blog.
content - whether contains the whole content of each article. If false, the generated results only cover title and other meta info without mainbody. By default is true.
format - the form of the page contents, options are:
- html (Default) - original html string being minified.
- striptags - original html string being minified, and remove all the tags.
- raw - markdown text of each posts or pages.

FAQ

What's this plugin supposed to do?

This plugin is used for generating a xml / json file from your Hexo blog that provides data for searching.

Where's this file saved to?

After executing hexo g you will get the generated result at your public folder.

How to use this plugin in my Hexo blog?

You have two choices:

you don't want to write search engine by yourself. There are many themes that take use this plugin for local searching that works out of box.
you are familiar with JavaScript and would like to write your own search engine. You can implement one by yourself according to the template code search.js. There is no documentation at present, but you can find its usage in the source code of the theme NexT. Generally there are 3 steps:
1. write a search view. This is the place for displaying a search form and search results;
2. load the search.js script via CDN, for example:
```
1<script src="https://cdn.jsdelivr.net/npm/hexo-generator-searchdb@1.4.0/dist/search.js"></script>
```
A LocalSearch class is provided in the search.js which tells the browser how to grab search data and filter out contents what we're searching;
1. write a search script, make use of the previous LocalSearch class.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

Score

3.9

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More