npmpackage.info

Gathering detailed insights and metrics for @eastuni/antora-site-generator-lunr-ko

@eastuni/antora-site-generator-lunr-ko - 0.6.3 | npmpackage.info

@eastuni/antora-site-generator-lunr-ko

An Antora's site generator that produces a Lunr index

0.6.3

MIT

JavaScript

9.50 kB

2.6

Installations

npm install @eastuni/antora-site-generator-lunr-ko

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>= 8.0.0

Node Version

14.16.1

NPM Version

6.14.12 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

Dockerfile

JavaScript (93.85%)

Dockerfile (6.15%)

Developer

eastuni

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

212 Commits

1 Branches

1 Contributors

Updated on May 03, 2021

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

0.6.3

Package Id

@eastuni/antora-site-generator-lunr-ko@0.6.3

Unpacked Size

9.50 kB

Size

3.54 kB

File Count

NPM Version

6.14.12

Node Version

14.16.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@eastuni/antora-lunr-ko @antora/asciidoc-loader @antora/content-aggregator @antora/content-classifier @antora/document-converter @antora/navigation-builder @antora/page-composer @antora/playbook-builder @antora/redirect-producer @antora/site-mapper @antora/site-publisher @antora/ui-loader

Dev Dependencies

@antora/asciidoc-loader @antora/content-aggregator @antora/content-classifier @antora/document-converter @antora/navigation-builder @antora/page-composer @antora/playbook-builder @antora/redirect-producer @antora/site-mapper @antora/site-publisher @antora/ui-loader chai cheerio dirty-chai fs-extra mocha rimraf

Optional Dependencies

2021-05-03 add language ko

==============

Antora Site Generator With Lunr

This site generator is a copy of the default site generator that in addition produces a Lunr index that can be used in your documentation UI. Lunr provides a great search experience in your documentation site without the need for external, server-side, search services.

Antora is a modular static site generator designed for creating documentation sites from AsciiDoc documents. Its site generator pipeline aggregates documents from versioned content repositories and processes them using Asciidoctor.

Usage

Install the site generator. Open a terminal and type:

$ npm i -g antora-site-generator-lunr

When generating your documentation site, use the --generator option:

$ DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr NODE_PATH="$(npm -g root)" antora --generator antora-site-generator-lunr site.yml

NOTE: The NODE_PATH assignment is necessary to ensure Antora can locate node modules install globally. Depending on your environment, you may find that this assignment is unnecessary. If you've installed Antora globally using Yarn, you may need to add "$(yarn global dir)/node_modules" to the NODE_PATH environment variable instead.

Please read the documentation to enable the search component in your documentation UI.

Using the Docker image

The Docker image is built upon the Antora's official Docker 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 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

When installing this generator globally (i.e., npm i -g), it also installs a private copy of Antora (minus the CLI). Thus, to upgrade the copy of Antora this site generator uses, you need to reinstall this package. Upgrading Antora alone isn't sufficient.

To upgrade this site generator and Antora, open a terminal and type the following commands:

$ 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

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/eastuni/antora-site-generator-lunr/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/eastuni/antora-site-generator-lunr/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-docker.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/eastuni/antora-site-generator-lunr/release-docker.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-docker.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/eastuni/antora-site-generator-lunr/release-docker.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-docker.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/eastuni/antora-site-generator-lunr/release-docker.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-docker.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/eastuni/antora-site-generator-lunr/release-docker.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-docker.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/eastuni/antora-site-generator-lunr/release-docker.yml/main?enable=pin
Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating antora/antora:2.3.4 to antora/antora:2.3.4@sha256:61952efd4c53c854e7ecd445ae29ad4bf5a0dc37c2389b7aba9906da3faccc4f
Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned
Info: 0 out of 1 containerImage dependencies pinned
Info: 1 out of 1 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More