Search

The search functionality is provided by algolia and is known as algolia DocSearch

Relevant issues

For details, look through the issue comments

• add search box #73
• restrict DocSearch to relevant parts of the site #77
• sitemapindex #79

Configuration

To change the configuration, make a PR against https://github.com/algolia/docsearch-configs/blob/master/configs/mdanalysis.json

The syntax is explained at https://docsearch.algolia.com/docs/config-file/

Working with sitemaps

• sitemap.org protocol definition (defines sitemap)
• validators
  • https://www.xml-sitemaps.com/validate-xml-sitemap.html

When making a PR

Please:

• provide enough information so that others can review your pull request.
• double check the dedicated documentation available here
• try to implement the recommendations
• please feature a sitemap, it will be the most complete source of truth for our crawling.
• Allow edits from maintainer