mixin compilerDoc::DocCrawler

compilerDoc::DocCrawler

Source

DocCrawler provides an interface to implement by search engine crawlers when crawling a specific document via Doc.onCrawl.

addFandoc

abstract Void addFandoc(DocFandoc fandoc)

Source

Add fandoc formatted text to the index for current doc

addKeyword

abstract Void addKeyword(Str keyword, Str title, DocFandoc summary, Str? anchor)

Source

Add a search keyword with a curated title, summary formatted as fandoc, and an optional fragment anchor within the document. This is used to index API keywords like types, slot name, qnames, etc. The summary is used only for hit higlighting and should be added to the index itself separately.

addText

abstract Void addText(Str str)

Source

Add plain, unformatted text to the index for current doc