typedoc: The search index is not available

It’s my typedoc.json file

{
  "inputFiles": ["./src"],
  "mode": "modules",
  "out": "docs",
  "ignoreCompilerErrors": true,
  "disableOutputCheck": true,
  "excludeExternals": true,
  "excludePrivate": true,
  "excludeNotExported": true
}

What can I do to use search

About this issue

Original URL
State: closed
Created 4 years ago
Reactions: 1
Comments: 15 (6 by maintainers)

Most upvoted comments

Try serving de docs with something like https://www.npmjs.com/package/serve

npx serve docs

The search component is doing a fetch, and on the other hand the search.js file is being injected with document.write (even in 0.10.1). This is only done for file:// protocol, which suggests you might just be opening the html without a server, but then fetch may not work (chrome only allows it in http or https).

ferhtgoldaraz on Apr 21, 2020

It says search.js 404.

Here’s my config:

  "typedocOptions": {
    "excludeExternals": true,
    "excludeNotExported": true,
    "excludePrivate": true,
    "excludeProtected": true,
    "inputFiles": "src",
    "out": "docs"
  },

eidng8 on Apr 20, 2020

If Chrome or Firefox implemented a particular limitation, then it’d probably make sense for Typedoc to make another workaround as Typedoc is built for web browsers and are tied to platform requirements.

Having a development mode, which would be functionally the same as production, would be beneficial in trying out the doc rendering quickly.

Fleker on Jul 28, 2020

@sgrishchenko that approach works fine when you are hosting the files on GitHub or some other server, but it does not work if you try to open the files locally file:///usr/.../docs/index.html, where I get the error:

main.js:6 Fetch API cannot load file:///usr/.../docs/assets/js/search.json. URL scheme must be "http" or "https" for CORS request.

Unless I take the advice above and have to spin up a local server using npx serve docs.

Having an improvement in speed is definitely beneficial, but being able to run locally through some fallback behavior would still be useful.

The theme default.hbs previously had the line:

<script>if (location.protocol == 'file:') document.write('<script src="{{relativeURL "assets/js/search.js"}}"><' + '/script>');</script>

which could return to provide some sort of substitute implementation when the script is activated.

Fleker on Jul 27, 2020