https://github.com/leungwensen/doc-indexer

built for static page full-text search
https://github.com/leungwensen/doc-indexer

documentation full-text-search indexing

Last synced: 29 days ago
JSON representation

built for static page full-text search

• Host: GitHub
• URL: https://github.com/leungwensen/doc-indexer
• Owner: leungwensen
• License: mit
• Created: 2017-03-08T09:30:31.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-03-08T10:22:56.000Z (over 7 years ago)
• Last Synced: 2024-09-15T01:46:47.305Z (about 2 months ago)
• Topics: documentation, full-text-search, indexing
• Language: JavaScript
• Size: 33.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
doc-indexer

===========

built for static page full-text search

![structure](./assets/structure.png)

## install

```shell

$ npm i doc-indexer --save

```

## DocSet

html, markdown, etc.

## tokens

```javascript

{

    docs: {

        a: 'uri/to/a-file',

        b: 'uri/to/b-file',

    },

    tokens: {

        'someToken': {

            stem: 'someToken',

            minSize: 8,

            maxSize: 9,

            count: 10,

            indices: [

                {

                    ranking: 0,

                    link: '#xxx',

                    doc: 'a',

                    index: 0

                }

            ]

        }

    }

}

```

## use in terminal

TODO

## use in browser

TODO