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

gitbook-plugin-docsearch

v1.2.0

Published

GitBook search plugin for algolia docsearch

Downloads

4

Readme

GitBook Plugin to add Algolia docSearch Plugin

Installation

npm install gitbook-plugin-docsearch

Usage

Gitbook comes with default search option. In order to use this plugin, need to disable the default search plugins and add docSearch as bellow :

"plugins": [
    "-search",
    "-lunr",
    "docsearch"
  ]

add the following plugin configurations in book.json

{
   "pluginsConfig": {
     "docSearch": {
       "apiKey" : "replace_with_algolia_doc_search_api_key",
       "index" : "replace_with_algolia_doc_search_index",
        "logo" : "logo.png",
        "brandUrl" : "https://uilicious.com/"
     }
   }
}

logo and brandUrl is optional. So you can choose to leave them empty if you do want want to put your brand logo in Gitbook.

But, if you want to use logo then put the logo image into the root directory of your Gitbook project.

In order to customize the styling of your search experience you can supply a css separately as bellow inside book.json

"addcssjs": {
   "css": [
        "css/replace_with_your_file_name.css"
        ]
    }

Known issues

The default behaviour of algolia search result prompt crops out. See bellow :

In order to fix it, apply the following css with styling

/* FIX for algolia search box getting cropped off */
/* FIX-START*/

.book.with-summary .book-summary {

    display: flex;
    flex-direction: column;
    height: 100vh;
    overflow-y: hidden;

    /* reset */
    position: relative;
    left: auto;
    top: auto;
    bottom: auto;
    z-index: auto;
    width: inherit;
    border: none;

}

.book-summary > a, /*logo*/
#book-search-input,
.book-summary > nav {
    width: 300px;
}

@media (max-width: 600px) {
    .book-summary > a, /*logo*/
    #book-search-input,
    .book-summary > nav {
        width: auto;
    }
}

.book.with-summary .book-body {
    border-left: 1px solid rgba(0, 0, 0, 0.07);
}

#book-search-input {
    margin-bottom: 0;
}

.book-summary > nav {
    overflow-y: auto;
}

/* FIX-END*/

License & copyright

Licensed under the MIT License