Chemr

Introduction

1. Enable indexer at settings dialog.
2. Start initial indexing by selecting icon.
3. Ready to query.

Select Index

Press Control + Enter to open select index dialog.

Or Alt + [Number] / Command + [Number] for selecting index directly.

Keyboard shortcuts

Reindex by hand

To reindex by hand for updating to latest index. Right click or double click index icon and open menu by clicking gear icon.

Indexer definition file

This is a sample indexer definition for PHP:

export default {
  id: 'php',
  name: 'PHP',
  color: '#4F5B93',

  async index(ctx) {
    const url = 'https://www.php.net/manual/en/indexes.functions.php';
    const doc = await ctx.fetchDocument(url);

    const links = doc.querySelectorAll('ul.gen-index a');
    for (const link of links) {
      const text = link.textContent.trim();
      const href = link.getAttribute('href');
      if (href) {
        ctx.pushIndex(text, href);
      }
    }
  },

  urlTemplate: 'https://www.php.net/manual/en/${url}'
};

id : string

Unique identifier for this indexer.

name : string

Display name.

async index(ctx: IndexerContext): Promise<void>

A function for creating index. Use ctx.pushIndex(name, url) to add entries.

urlTemplate : string

Template for generating final URLs. ${url} will be replaced by the URL passed to pushIndex.

css : string

Custom CSS to be injected into the document view.

IndexerContext

IndexerContext is passed as index() argument.

pushIndex(name: string, url: string)

Add specified index entry.

fetchDocument(url: string): Promise<Document>

Fetches a URL and returns a DOM Document object (parsed via linkedom).

fetchJSON(url: string): Promise<any>

Fetches a URL and parses it as JSON.

fetchText(url: string): Promise<string>

Fetches a URL and returns its text content.

crawl(urls: string[], callback: (url, doc): void): Promise<void>

Crawl specified URLs and call callback for each document.