antora-site-generator-lunr - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

lib/generate-site.js

		@@ -18,7 +18,7 @@ 'use strict'
		const playbook = buildPlaybook(args, env)
		const asciidocConfig = resolveAsciiDocConfig(playbook)
		const [contentCatalog, uiCatalog] = await Promise.all([
		aggregateContent(playbook).then((contentAggregate) => classifyContent(playbook, contentAggregate)),
		aggregateContent(playbook).then((contentAggregate) => classifyContent(playbook, contentAggregate, asciidocConfig)),
		loadUi(playbook),
		])
		const asciidocConfig = resolveAsciiDocConfig(playbook)
		const pages = convertDocuments(contentCatalog, asciidocConfig)
		@@ -25,0 +25,0 @@ const navigationCatalog = buildNavigation(contentCatalog, asciidocConfig)

package.json

		{
		"name": "antora-site-generator-lunr",
		"version": "0.5.0",
		"version": "0.6.0",
		"description": "An Antora's site generator that produces a Lunr index.",
		@@ -33,3 +33,3 @@ "license": "MIT",
		"dependencies": {
		"antora-lunr": "0.7.1"
		"antora-lunr": "0.8.0"
		},
		@@ -52,3 +52,3 @@ "devDependencies": {
		"fs-extra": "^8.1.0",
		"mocha": "^7.1.2",
		"mocha": "^8.0.1",
		"rimraf": "^3.0.2"
		@@ -55,0 +55,0 @@ },

README.md

		@@ -29,2 +29,21 @@ # Antora Site Generator With Lunr

		### Using the Docker image

		[The Docker image](https://hub.docker.com/r/ggrossetie/antora-lunr) is built upon [the Antora's official Docker image](https://docs.antora.org/antora/2.3/antora-container/#run-the-antora-image) and should be used as a replacement.
		For example, instead of running:

		$ docker run -u $(id -u) -v $PWD:/antora:Z --rm -t antora/antora:2.3.4 antora-playbook.yml

		You will run:

		$ docker run -u $(id -u) -v $PWD:/antora:Z --rm -t ggrossetie/antora-lunr antora-playbook.yml

		The image sets `DOCSEARCH_ENABLED=true` and `DOCSEARCH_ENGINE=lunr` environment variables.
		When executing `docker run`, you can [overwrite any variable](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) defined in the image.
		For example:

		$ docker run --env DOCSEARCH_ENABLED=false # ...

		Moreover, the site generator is automatically configured on the `antora` command (i.e. `--generator antora-site-generator-lunr`).

		## Upgrading
		@@ -39,4 +58,5 @@
		$ npm uninstall -g antora-site-generator-lunr @antora/cli @antora/site-generator-default
		npm i -g antora-site-generator-lunr @antora/cli @antora/site-generator-default

		$ npm i -g antora-site-generator-lunr @antora/cli @antora/site-generator-default

		These commands ensure you have the latest version of both the site generator and Antora regardless of whether you're using this site generator.

Improved metrics