This repository has been archived by the owner on Nov 26, 2022. It is now read-only.
Releases: ggrossetie/antora-lunr
Releases · ggrossetie/antora-lunr
v0.8.0
This release includes bug fixes and improvements from three contributors! 🤗
Bug fixes
- Add
contentCatalog
andenv
parameters to generateIndex() to avoiderror: Cannot read property
DOCSEARCH_INDEX_VERSION` of undefined - thanks @Janaka-Steph
Improvements
- Don't index pagination navigation as these are the titles of other pages and it would otherwise pollute the index - thanks @ahus1
- Add
basePath
andpagePath
as data attributes to avoid using an inline script (might be blocked by strict Content-security-policy) - thanks @citizenken
Infrastructure
- Bump standard from 14.3.3 to 14.3.4
- Bump mocha from 7.1.2 to 8.1.3
- Bump js-yaml from 3.13.1 to 3.14.0
- Bump lodash from 4.17.14 to 4.17.19
v0.7.1
This release includes a tiny fix to synchronize the footer template with the Antora default UI.
Bug fixes
- Synchronize the footer template with the Antora default UI (
highlight.js
script is now self-contained)
v0.7.0
This release includes two improvements from two contributors! 🎉
💡 Don't forget to update your UI to at least define window.antora.basePath
. This variable will be used to construct the complete URL of search results client-side:
<script>
window.antora = window.antora || {}
window.antora.basePath = '{{or siteRootPath (or site.url siteRootUrl)}}'
</script>
Improvements
- Allow indexing only latest version using
DOCSEARCH_INDEX_VERSION=latest
- thanks @danyill - Use relative paths to make the index portable/relocatable (the site path will prepended in the UI) - thanks @djencks
Infrastructure
- Upgrade development dependencies
- Bump mocha from 7.1.1 to 7.1.2
- Run
npm audit fix
v0.6.0
Improvements
- Package
supplemental_ui
directory in the npm package - Hide the search results when you click outside of the search results box (thanks @Janaka-Steph)
- Upgrade lunr.js to 2.3.8
- If the site URL is set, only use the pathname segment
- Exclude pages when
noindex
is defined as page attribute or as meta tag - Resolve the document title when there's multiple first level headings
- Use a begins with and contains search if there's no result
Documentation
- Add a link to
antora-site-generator-lunr
package
Infrastructure
- Upgrade development dependencies
- Bump html-entities from 1.2.1 to 1.3.1
- Bump mocha from 5.2.0 to 7.1.1
- Bump cheerio from 1.0.0-rc.2 to 1.0.0-rc.3
- Bump standard from 12.0.1 to 14.3.3
- Bump chai from 4.1.2 to 4.2.0
- Bump acorn from 6.1.1 to 6.4.1
- Run
npm audit fix
v0.5.0
Improvements
- load the index as a JavaScript file
- remove pako dependency
- use a script element to load the index file
- search-index.js can be gzipped on the server
- Provide a supplemental directory and update the README
- Use a fixed width in percent on the search results box
- Improve the highlighting style
v0.4.0
Improvements
- Upgrade Lunr to version 2.3.3
- Ignore navigation and TOC titles
- Compress the index file using pako (credits @eskwayrd)
- Only index the document contents (thanks @campbellbartlett)
- If the site URL is not defined, use a relative URL (thanks @campbellbartlett)
- If a title does not have an id then do not index it (which prevents a Lunr typescript error in browser) (thanks @campbellbartlett)
Documentation
- General improvements in instructions and handling CORS and local sites (thanks @danyill)
- Improve installation instructions (thanks @myii)
Infrastructure
- Use standard linter
- Enable Travis