npmpackage.info

jsdoc-fresh

A clean, responsive documentation template with search and navigation highlighting for JSDoc 3.

3.0.0

Apache-2.0

JavaScript

Installations

npm install jsdoc-fresh

Score

86.8

Supply Chain

97.6

Quality

78.1

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

5

Total

133

Closed

26

Merged

102

Issues

Open

4

Total

11

Closed

7

Releases

v3.0.0

Published on 10 Aug 2023

v2.0.2

Published on 02 May 2023

v2.0.1

Published on 26 Aug 2022

v2.0.0

Published on 06 Jun 2022

jsdoc-fresh v1.1.1

v1.1.1

Published on 11 Aug 2021

v1.1.0

Published on 07 Jun 2021

View all 12 releases

Developer

googleapis

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

>=14.0.0

Typescript Support

No

Node Version

14.21.3

NPM Version

6.14.18 Statistics

14 Stars

178 Commits

10 Forks

42 Watching

32 Branches

118 Contributors

Updated on 21 Oct 2024

Languages

JavaScript (57.86%)

CSS (40.51%)

Python (1.63%)

Total Downloads

Cumulative downloads

Total Downloads

6,821,003

Last day

-29.4%

1,303

Compared to previous day

Last week

-0.4%

5,948

Compared to previous week

Last month

11.7%

22,988

Compared to previous month

Last year

-56.8%

182,168

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@jsdoc/salty

Dev Dependencies

gts typescript

Versions

Fresh JSDoc Template

A clean, responsive documentation template with search and navigation highlighting for JSDoc 3. Forked from github.com/braintree/jsdoc-template.

Braintree JS Doc Template Screenshot

Responsive

Braintree JS Doc Template Screenshot

Uses

Usage

Clone repository to your designated jsdoc template directory, then:

Node.js Dependency

In your projects package.json file add a generate script:

1"script": {
2  "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
3}

In your .jsdoc.json file, add a template option.

1"opts": {
2  "template": "node_modules/jsdoc-fresh"
3}

Example JSDoc Config

1{
2    "tags": {
3        "allowUnknownTags": true,
4        "dictionaries": ["jsdoc"]
5    },
6    "source": {
7        "include": ["lib", "package.json", "README.md"],
8        "includePattern": ".js$",
9        "excludePattern": "(node_modules/|docs)"
10    },
11    "plugins": [
12        "plugins/markdown"
13    ],
14    "templates": {
15        "referenceTitle": "My SDK Name",
16        "disableSort": false,
17        "collapse": true,
18        "resources": {
19            "google": "https://www.google.com/"
20        }
21    },
22    "opts": {
23        "destination": "./docs/",
24        "encoding": "utf8",
25        "private": true,
26        "recurse": true,
27        "template": "./node_modules/jsdoc-template"
28    }
29}

Note: referenceTitle and disableSort will affect the output of this theme.

If you would like to enable Algolia DocSearch, you can pass a search object into the templates object.

1"templates": {
2    "search": {
3        "apiKey": "your-api-key",
4        "indexName": "Your index name. Defaults to braintree.",
5        "hitsPerPage": "Number of Results to show. Defaults to 7.",
6    }
7}

License

Licensed under the Apache2 license.

No vulnerabilities found.

10

Dangerous-Workflow

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

10

Security-Policy

Determines if the project has published a security policy.

10

Code-Review

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

10

Binary-Artifacts

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

2

SAST

Determines if the project uses static code analysis.

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

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 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/response.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/response.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/response.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/jsdoc-fresh/response.yaml/main?enable=pin
Warn: npmCommand not pinned by hash: .kokoro/docs.sh:23
Warn: npmCommand not pinned by hash: .kokoro/lint.sh:23
Warn: npmCommand not pinned by hash: .kokoro/lint.sh:29
Warn: npmCommand not pinned by hash: .kokoro/publish.sh:29
Warn: npmCommand not pinned by hash: .kokoro/release/docs-devsite.sh:27
Warn: npmCommand not pinned by hash: .kokoro/release/docs-devsite.sh:28
Warn: npmCommand not pinned by hash: .kokoro/release/docs.sh:27
Warn: npmCommand not pinned by hash: .kokoro/release/docs.sh:31
Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:35
Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:40
Warn: npmCommand not pinned by hash: .kokoro/system-test.sh:34
Warn: npmCommand not pinned by hash: .kokoro/test.sh:23
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:23
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:26
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:48
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:57
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 0 out of 16 npmCommand dependencies pinned

0

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

Score

5.7

/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

Other packages similar to jsdoc-fresh

import-fresh

3.3.0

Import a module while bypassing the cache

fresh

0.5.2

HTTP response freshness testing

jsdoc-type-pratt-parser

4.1.0

[![Npm Package](https://badgen.net/npm/v/jsdoc-type-pratt-parser)](https://www.npmjs.com/package/jsdoc-type-pratt-parser) [![Test Status](https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/actions/workflows/test.yml/badge.svg?branch=main)]

eslint-plugin-jsdoc

50.6.0

JSDoc linting rules for ESLint.