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

doc-navigator

v0.4.6

Published

DocNavigator is an AI-powered chatbot builder that is designed to improve the user experience on product documentation/support websites.

Downloads

67

Readme

DocNavigator

DocNavigator is an AI-powered chatbot builder that is designed to improve the user experience on product documentation/support websites. It can be trained on the data available on the company's website, making it a scalable solution for organizations of any size.

With its ability to handle multiple queries at once, DocNavigator can save customers time and boost productivity, all while improving customer satisfaction.

Installation

To use the DocNavigator, you'll need to have npm or yarn installed.

  1. Install the package using npm or yarn:

    npm install doc-navigator

    or

    yarn add doc-navigator
  2. Import the SearchComponent in your React component:

    import { SearchComponent } from 'doc-navigator';

Usage

To use the DocNavigator, simply add SearchComponent to your React component's render method:

import React from 'react';
import { SearchComponent } from 'doc-navigator';

export const MyComponent = () => {
  return (
    <div>
      <h1>My Component</h1>
     <SearchComponent
        url="https://docnavigator.in" // [Visit here for more info](https://github.com/vgulerianb/DocNavigator)
        projectId="8c1fe927-d91f-471d-8de4-ded76a58d686"
        variant="dark" //light
        welcomeMessage="Hi, how can I help you?"
     />
    </div>
  );
};

Props

The SearchComponent accepts the following props:

  • url (string, required): The URL of the search endpoint. // Visit here for more info
  • welcomeMessage (string, optional): An optional welcome message to display above the search box.
  • projectId (string, required): The ID of the project to search within.
  • variant ('dark' | 'light', optional): The color variant of the search component. Use 'dark' for dark mode and 'light' for light mode.
  • width (string, optional): The width of the search component.
  • height (string, optional): The height of the search component.
  • searchComponent (React component, optional): An optional custom search component to use instead of the default one.

That's it! You should now be able to use the `SearchComponent` in your React project. Feel free to raise a issue if you have any doubt.