Local

To perform a local search of your documentation press key or click the search section in the side panel on the left. In documentation structure we learned that documentation consist of Chapters Pages Page Sections These entities play different and important roles in search. Search treats each Page Section as an independent unit. Each Page Section has an internally defined title that is a combination of all three titles. Title match during search yields the highest score. For example this current section full title is: Flow Search Local. Queries with special characters like or are additionally matched verbatim: sections containing the exact text appear first. Wrap a query in quotes, e.g. , to only match sections containing the exact text. As your documentation grows, keep checking how easy it is to navigate to a section of your documentation using . Avoid: using generic names in your page titles and page section titles. You should not have dozens of pages called Introduction / List.map c++ "List.map" /

Global

Besides local search capabilities, provides a search entry file for your documentation. This file can be crawled to expose your documentation to external search engines. Your search entry file can be located at the following endpoint: For example, the search entry for the documentation on Github is located at https://testingisdocumenting.org/znai/search-entries.xml Znai XML <base-url>/<doc-id>/search-entries.xml Znai