npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gbook-plugin-lunr

v1.0.0

Published

该插件提供了搜索插件的后端

Downloads

3

Readme

lunr

该插件提供了搜索插件的后端。

该插件是默认插件。

禁用此插件

这是默认插件,可以使用以下 book.json 配置禁用它:

{
    "plugins": ["-lunr"]
}

局限性

Lunr不能为一本巨大的书编制索引,默认情况下,索引大小限制为 ~100ko

您可以通过设置配置来更改此限制 maxIndexSize

{
    "pluginsConfig": {
        "lunr": {
            "maxIndexSize": 200000
        }
    }
}

向页面添加关键字

您可以为任何页面指定显式关键字。搜索这些关键字时,页面在结果中的排名会更高。

---
search:
    keywords: ['keyword1', 'keyword2', 'etc.']

---

# My Page

This page will rank better if we search for 'keyword1'.

禁用页面索引

您可以通过向页面添加YAML标头来禁用特定页面的索引编制:

---
search: false
---

# My Page

This page is not indexed in Lunr.

忽略特殊字符

默认情况下,将考虑特殊字符,以允许特殊搜索,例如 "C++" 或 "#word"。如果您的文字基本上是英文散文,则可以禁用此 ignoreSpecialCharacters 选项,并带有以下选项:

{
    "pluginsConfig": {
        "lunr": {
            "ignoreSpecialCharacters": true
        }
    }
}