npmpackage.info

@aldridged/docusaurus-plugin-lunr

Docusaurus v2 plugin to create a local search index for use with Lunr.js

1.0.0-alpha.10

MIT

TypeScript

Installations

npm install @aldridged/docusaurus-plugin-lunr

Score

24.7

Supply Chain

55.6

Quality

66.7

Maintenance

Vulnerability

94.3

License

Pull Requests

Open

22

Total

31

Closed

9

Issues

Open

7

Total

10

Closed

3

Releases

v1.0.0-alpha.10

Published on 06 Jul 2020

v1.0.0-alpha.9

Published on 06 Jul 2020

Bump dependencies

v1.0.0-alpha.8

Published on 22 Apr 2020

Minor bugfix release

v1.0.0-alpha.7

Published on 19 Feb 2020

Bump Docusaurus dependencies

v1.0.0-alpha.6

Published on 19 Feb 2020

Minor bugfix release

v1.0.0-alpha.5

Published on 18 Feb 2020

View all 9 releases

Developer

daldridge

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=8.9

Typescript Support

No

Node Version

12.18.1

NPM Version

6.14.5 Statistics

50 Stars

25 Commits

5 Forks

3 Watching

21 Branches

2 Contributors

Updated on 11 May 2024

Languages

TypeScript (55.48%)

JavaScript (35.45%)

CSS (9.07%)

Total Downloads

Cumulative downloads

Total Downloads

87,494

Last day

22.1%

166

Compared to previous day

Last week

91.9%

825

Compared to previous week

Last month

-78%

2,290

Compared to previous month

Last year

53.4%

28,522

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

docusaurus-plugin-lunr

Docusaurus v2 plugin to create a local search index for use with Lunr.js

Note: This library was created with typescript-starter. Currently, the test target fails with Prettier formatting compliance errors. The plugin does build and run, so I'm ignoring Prettier for now.

Installation

Install the plugin with npm:

1npm install --save @aldridged/docusaurus-plugin-lunr

Add the plugin do docusaurus.config.js:

1module.exports = {
2  // ...
3  plugins: [
4    // ...
5    '@aldridged/docusaurus-plugin-lunr'
6  ]
7};

Generated index

The plugin watches and processes markdown files in a similar manner to the official docusaurus-plugin-content-docs plugin. The content is stripped of HTML tags and Markdown formatting, and the resulting plaintext is added to a Lunr.js index which gets serialized to the standard Docusaurus v2 plugin contentLoaded createData output location (by default, <repo>/.docusaurus/docusaurus-plugin-lunr/search-index.json).

The index contains the following fields for each document:

content: plaintext content
route: the permalink for the generated document route
title: document title found in the front matter
version: the associated documentation version, or null if no versions are present

SearchBar component

The plugin includes a theme SearchBar theme component which consumes the Lunr index. By including the plugin in the Docusaurus config, the Navbar will include the SearchBar component which uses the generated search index. This works because the plugin-generated index is available via import, as the Docusaurus v2 core Webpack configuration configures an alias for @generated.

Known limitations

The custom React hook used by the SearchBar component performs a dynamic import via import(@site/versions.json). If a versions.json file is not present at the root of your docs repo, this will throw, and you apparently not catch that error and use a default empty array. The versions.json file is not created until you use the Docusaurus CLI to archive a varsion. Note that this plugin does not actually require you to have versions -- it only needs version.json, so the current suggestion is to manually create the file with emtpy array contents.

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.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

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

0

Token-Permissions

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

0

Pinned-Dependencies

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

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

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.

Reason

57 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-xp63-6vf5-xf3v
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-mhxj-85r3-2x55
Warn: Project is vulnerable to: GHSA-8mmm-9v2q-x3f9
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-gxr4-xjj5-5px2
Warn: Project is vulnerable to: GHSA-jpcq-cgw6-v4j6
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
Warn: Project is vulnerable to: GHSA-qxg5-2qff-p49r
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq
Warn: Project is vulnerable to: GHSA-3329-pjwv-fjpg
Warn: Project is vulnerable to: GHSA-p6j9-7xhc-rhwp
Warn: Project is vulnerable to: GHSA-89gv-h8wf-cg8r
Warn: Project is vulnerable to: GHSA-gcv8-gh4r-25x6
Warn: Project is vulnerable to: GHSA-gmv4-r438-p67f
Warn: Project is vulnerable to: GHSA-8h2f-7jc4-7m3m
Warn: Project is vulnerable to: GHSA-3vjf-82ff-p4r3
Warn: Project is vulnerable to: GHSA-g694-m8vq-gv9h
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.5

/10

Last Scanned on 2024-11-25

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

@aldridged/docusaurus-plugin-lunr

Installations

Score

Pull Requests

22

31

9

Issues

7

10

3

Releases

Developer

daldridge

Developer Guide

CommonJS

>=8.9

No

12.18.1

6.14.5

Statistics

Languages

Total Downloads

87,494

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

docusaurus-plugin-lunr

Installation

Generated index

SearchBar component

Known limitations

10

10

10

0

0

0

0

0

0

0

0

0

0

2.5

/10