illuminsight cookbook

This repository contains recipes that assist illuminsight's insight generation process for specific published media.

Contribute

If you'd like to add a new recipe or improve an existing one:

1. Add or edit a JSON file in src/recipes/.
2. Update src/recipes/.index.json if needed.
3. Submit your pull request.

Do not modify anything in dist/. Run npm run build for testing but do not commit any changes in dist/.

JSON Structures

src/recipes/<id>.json and dist/recipes/<id>.min.json

interface Recipe {
  // In descending order of priority
  searches: {
    context?: string;
    name: string;
    url: string;
  }[];
  // In descending order of priority
  wikis: {
    proxy?: boolean;
    name: string;
    url: string;
    api: string;
  }[];
  id: string;
}

src/recipes/.index.json

Array<{
  /**
   * File name without extension within `recipes/`.
   * @example "a-song-of-ice-and-fire"
   * @example "the-lord-of-the-rings"
   * @example "harry-potter"
   */
  id: string;
  /**
   * A string of possible book titles.
   * @example "Harry Potter and the Sorcerer's Stone Harry Potter and the Philosopher's Stone"
   * @example "A Game of Thrones A Dance with Dragons"
   * @example "The Fellowship of the Ring The Two Towers"
   */
  books?: string;
  /**
   * A string of possible series names.
   * @example "The Lord of the Rings LOTR"
   * @example "Harry Potter"
   * @example "A Song of Ice and Fire Game of Thrones"
   */
  series?: string;
  /**
   * A string of possible author names.
   * @example "George R. R. Martin GRRM George RR Martin"
   * @example "JK Rowling J. K. Rowling"
   * @example "JRR Tolkien J.R.R. Tolkien Christopher Tolkien"
   */
  authors?: string;
}>

Regarding id and its corresponding recipe file name:

• It should be as short and descriptive as possible without abbreviations or truncation. Generally, if you stick to something's official title you should be good.
• Use hyphens to separate spaces.
• Use all lowercase characters.
• Avoid acronyms as they're likely to lead to confusion and future conflicts.
• An id should rarely, if ever change! Choose wisely.

There can be multiple entries in src/recipes/.index.json that point to the same recipe.

The books, series, and authors properties are used for matching searches to a recipe. Each should be a single string containing as many possible popular variations of matching book titles, series, or authors.

dist/recipes/.index.min.json

You shouldn't ever edit this file directly, but in case you need to read data from it:

Array<{
  i: string;  // id
  b?: string; // books
  s?: string; // series
  a?: string; // authors
}>