Registry / testing / bookshelf-jsdoc-theme

bookshelf-jsdoc-theme

JSON →
library1.0.1jsnpmunverified

A JSDoc theme forked from Minami, used to generate the docs on bookshelfjs.org. Version 1.0.1 is current. Released under Apache2. It uses TaffyDB and Underscore templates. This is a niche theme specifically for the Bookshelf.js ORM documentation, not intended for general-purpose JSDoc output. No active development since 2016.

testing
npm install bookshelf-jsdoc-theme
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · BOOKSHELF-JSDOC-TH
B
bookshelf-jsdoc-theme
testingjavascriptv1.0.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

theme
✓ // Install as dev dependency, configure in .jsdoc.json: "opts": { "template": "./node_modules/bookshelf-jsdoc-theme" }
✗ const theme = require('bookshelf-jsdoc-theme')
This package is a JSDoc template, not a library. It is used via JSDoc CLI or config, not imported directly in JavaScript.

Install the theme and configure JSDoc to use it for generating documentation.

npm install --save-dev bookshelf-jsdoc-theme # Create .jsdoc.json with: { "opts": { "template": "./node_modules/bookshelf-jsdoc-theme" } } # Run: jsdoc -c .jsdoc.json src/**/*.js
Debug
Known issues
gotchaThis theme is specifically designed for Bookshelf.js. It may not render other projects correctly.
fix
Use a general-purpose theme like Minami or default JSDoc theme for other projects.
affects: all
deprecatedPackage has not been updated since 2016. May not work with modern JSDoc versions.
fix
Consider using a maintained theme.
affects: >=1.0.1
Errors
Common errors & fixes
Error: Cannot find module 'bookshelf-jsdoc-theme'
Theme not installed or path misconfigured.
fix
Run 'npm install --save-dev bookshelf-jsdoc-theme' and ensure template path points to node_modules.
Upgrade
Version history
1.0.1latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
14 hits · last 30 days
node
12
OpenAI (training)
1
Resources
githubssh://git@github.com/bookshelf/bookshelf-jsdoc-theme ↗
packagebookshelf-jsdoc-theme ↗
homepagehttps://github.com/bookshelf/bookshelf-jsdoc-theme ↗
bookshelf-jsdoc-theme — npm install bookshelf-jsdoc-theme · libregistry