@braintree/jsdoc-template 4.0.0

package/CHANGELOG.md

@@ -0,0 +1,37 @@
+# CHANGELOG
+
+## 4.0.0
+
+- feat(deps): Add conventional commits
+- build(other): Upgrade to Node 18
+- feat(deps): Remove `taffydb`
+
+## v3.4.0 (2020-10-15)
+
+* Added a postprocess function option to template config options
+
+## 3.3.0
+
+* Added support for templates.collapse option. When set to true only the active component\'s members are expanded.
+* Added templates.resources option that takes an object where the keys are the labels and the values are links to external resources.
+* Minor css bugfixes
+
+## 3.2.0
+
+* Fix issue where all elements would be hidden if no excludePattern is included ([#16] thanks [@mercmobily])
+* Display bullet points in documentation ([#17]) thanks [@mercmobily])
+* Allow `disableSort` to be included in template to prevent automatic sorting of classes and methods ([#15] thanks [@mercmobily])
+
+## 3.1.1
+
+* Hide hidden modules from members section
+
+## 3.1.0
+
+* Add anchor tags to examples
+* Increase max-width of sections
+
+[@mercmobily]: /mercmobily/
+[#15]: /braintree/jsdoc-template/pull/15
+[#16]: /braintree/jsdoc-template/pull/16
+[#17]: /braintree/jsdoc-template/pull/17

package/LICENSE

@@ -0,0 +1,27 @@
+## JSDoc 3
+
+JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
+"License"). Commercial and non-commercial use are permitted in compliance with
+the License.
+
+Copyright (c) 2011-2015 Michael Mathews <micmath@gmail.com> and the
+[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
+All rights reserved.
+
+You may obtain a copy of the License at:
+http://www.apache.org/licenses/LICENSE-2.0
+
+In addition, a copy of the License is included with this distribution.
+
+As stated in Section 7, "Disclaimer of Warranty," of the License:
+
+> Licensor provides the Work (and each Contributor provides its Contributions)
+> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+> express or implied, including, without limitation, any warranties or
+> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+> PARTICULAR PURPOSE. You are solely responsible for determining the
+> appropriateness of using or redistributing the Work and assume any risks
+> associated with Your exercise of permissions under this License.
+
+The source code for JSDoc 3 is available at:
+https://github.com/jsdoc3/jsdoc

package/README.md

@@ -0,0 +1,89 @@
+# Braintree JSDoc Template
+
+A clean, responsive documentation template with search and navigation highlighting for JSDoc 3. Forked from [github.com/nijikokun/minami](https://github.com/nijikokun/minami).
+
+![Braintree JS Doc Template Screenshot](https://puu.sh/rWvW0/2831fd69d6.png)
+
+## Responsive
+
+![Braintree JS Doc Template Screenshot](https://puu.sh/rWvZ6/aee92a4787.png)
+
+## Uses
+
+- [JSdoc salty](https://github.com/jsdoc/jsdoc/tree/main/packages/jsdoc-salty)
+- [Underscore Template library](http://documentcloud.github.com/underscore/#template)
+- [Algolia DocSearch](https://community.algolia.com/docsearch/)
+
+## Usage
+
+Clone repository to your designated `jsdoc` template directory, then:
+
+### Node.js Dependency
+
+In your projects `package.json` file add a generate script:
+
+```json
+"script": {
+  "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
+}
+```
+
+In your `.jsdoc.json` file, add a template option.
+
+```json
+"opts": {
+  "template": "node_modules/jsdoc-template"
+}
+```
+
+### Example JSDoc Config
+
+```json
+{
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc"]
+    },
+    "source": {
+        "include": ["lib", "package.json", "README.md"],
+        "includePattern": ".js$",
+        "excludePattern": "(node_modules/|docs)"
+    },
+    "plugins": [
+        "plugins/markdown"
+    ],
+    "templates": {
+        "referenceTitle": "My SDK Name",
+        "disableSort": false,
+        "collapse": true,
+        "resources": {
+            "google": "https://www.google.com/"
+        }
+    },
+    "opts": {
+        "destination": "./docs/",
+        "encoding": "utf8",
+        "private": true,
+        "recurse": true,
+        "template": "./node_modules/jsdoc-template"
+    }
+}
+```
+
+Note: `referenceTitle` and `disableSort` will affect the output of this theme.
+
+If you would like to enable [Algolia DocSearch](https://community.algolia.com/docsearch/), you can pass a `search` object into the `templates` object.
+
+```json
+"templates": {
+    "search": {
+        "apiKey": "your-api-key",
+        "indexName": "Your index name. Defaults to braintree.",
+        "hitsPerPage": "Number of Results to show. Defaults to 7.",
+    }
+}
+```
+
+## License
+
+Licensed under the Apache2 license.

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@braintree/jsdoc-template",
+  "version": "4.0.0",
+  "description": "Braintree JSDoc 3 Template",
+  "main": "publish.js",
+  "files": [
+    "static",
+    "tmpl",
+    "publish.js",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "test": "npm run lint",
+    "preversion": "./scripts/preversion",
+    "prepare": "husky",
+    "commit": "cz"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/braintree/jsdoc-template"
+  },
+  "author": "Braintreeps <code@getbraintree.com>",
+  "licenses": [
+    {
+      "type": "Apache-2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/braintree/jsdoc-template"
+  },
+  "homepage": "https://github.com/braintree/jsdoc-template",
+  "devDependencies": {
+    "@commitlint/cli": "^20.5.0",
+    "@commitlint/config-conventional": "^20.5.0",
+    "@jsdoc/salty": "^0.2.12",
+    "commitizen": "^4.3.1",
+    "cz-customizable": "^7.5.4",
+    "eslint": "^8.13.0",
+    "eslint-config-braintree": "^5.0.1",
+    "husky": "^9.1.7"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-customizable"
+    }
+  }
+}