From 68fc0503fe3e20f6a4a467e3c38b762abdd74a36 Mon Sep 17 00:00:00 2001 From: Jeff Williams Date: Sun, 5 Nov 2023 09:34:53 -0800 Subject: [PATCH 1/5] chore: add .md extension to .editorconfig --- .editorconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index 2eabf54..31d722f 100644 --- a/.editorconfig +++ b/.editorconfig @@ -3,6 +3,6 @@ charset = utf-8 insert_final_newline = true trim_trailing_whitespace = true -[{**/*.cjs, **/*.css,**/*.js,*.json,**/*.less,**/*.mjs,**/*.njk,**/*.scss,**/*.yaml}] +[{**/*.cjs, **/*.css,**/*.js,*.json,**/*.less,**/*.md,**/*.mjs,**/*.njk,**/*.scss,**/*.yaml}] indent_style = space indent_size = 2 From bf265cbf0334c51324f6ba1c4a917df05c68bd13 Mon Sep 17 00:00:00 2001 From: Jeff Williams Date: Sun, 5 Nov 2023 09:35:10 -0800 Subject: [PATCH 2/5] chore: update README --- README.md | 47 +++++++++++++++++++++++------------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 5b587bd..04a20d3 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,55 @@ -This repository contains the user documentation for [JSDoc 3][jsdoc]. Use this repository to report +This repository contains the user documentation for [JSDoc][jsdoc]. Use this repository to report documentation bugs, and to submit pull requests for improving the docs. If you just want to read the documentation, please visit [Use JSDoc][use-jsdoc]. - ## Contributing to the documentation -The HTML docs are generated with [Metalsmith][] and [Gulp][]. If you'd like to contribute to the -docs, make sure Node.js and npm are installed, then follow these steps: - -1. Clone this repository: - - git@github.com:jsdoc3/jsdoc3.github.com.git +The HTML docs are generated with [Eleventy][eleventy]. If you'd like to contribute to the docs, make +sure Node.js and npm are installed, then follow these steps: -2. Install Bower and Gulp globally: +1. Clone this repository: - npm install -g gulp - npm install -g bower + ``` + git clone https://github.com/jsdoc/jsdoc.github.io + ``` -3. Install the dependencies: +2. Install dependencies: - npm install - bower install + ``` + npm install + ``` -4. Make your changes in the `content` directory, which contains the source files for the docs. +3. Make your changes in the `content` directory, which contains the source files for the docs. The first few lines of each source file contain [YAML][] front matter, which is metadata in [YAML][] format. If you need to use the character `@` or `[` at the start of a YAML value, you can escape it with a backslash. For example, write `title: @class` as `title: \@class`. -5. Rebuild the HTML files: +4. Rebuild the HTML files, and run a local server so that you can review them: - gulp + ``` + npm run serve + ``` -6. Review the updated HTML files, and make sure your changes look okay. In particular, if you edited -the YAML front matter, make sure your changes are reflected in the generated HTML files. -7. Submit a pull request with your changes. +5. Review the updated HTML files on the local server, and make sure your changes look okay. In + particular, if you edited the YAML front matter, make sure your changes are reflected in the + generated HTML files. +6. Send a pull request with your changes. ## Legal stuff -Copyright (c) 2011-2014 by Michael Mathews and the JSDoc 3 documentation [contributors][]. +Copyright 2011 by the [contributors][] to the JSDoc documentation. This repository is licensed under the [Creative Commons Attribution-ShareAlike 3.0 Unported][cc] license. A copy of the license is included in the [`LICENSE` file][license]. [cc]: https://creativecommons.org/licenses/by-sa/3.0/legalcode [contributors]: https://github.com/jsdoc/jsdoc.github.io/graphs/contributors -[Gulp]: https://gulpjs.com/ +[eleventy]: https://www.11ty.dev/ [jsdoc]: https://github.com/jsdoc/jsdoc [license]: https://github.com/jsdoc/jsdoc.github.io/LICENSE -[Metalsmith]: https://www.metalsmith.io/ [use-jsdoc]: https://jsdoc.app/ -[YAML]: https://www.yaml.org/spec/1.2/spec.html +[YAML]: https://yaml.org/spec/1.2.2/ From 14c5a459ae780e39f6ad411ef7d466d9f34cd4b4 Mon Sep 17 00:00:00 2001 From: Minh Nguyen Date: Tue, 5 Dec 2023 12:30:21 +0700 Subject: [PATCH 3/5] Update tags-async.md (#245) replace `<` string by `<` --- content/tags-async.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tags-async.md b/content/tags-async.md index 5376dac..852ea30 100644 --- a/content/tags-async.md +++ b/content/tags-async.md @@ -37,7 +37,7 @@ The following example shows a virtual comment that uses the `@async` tag: * @async * @function downloadData * @param {string} url - The URL to download from. - * @return {Promise<string>} The data from the URL. + * @return {Promise} The data from the URL. */ ``` From d33e8bd75b04f573abec187797b3984e2dcbf094 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 23 Jun 2024 12:30:40 -0700 Subject: [PATCH 4/5] Bump ws from 8.14.2 to 8.17.1 (#252) Bumps [ws](https://github.com/websockets/ws) from 8.14.2 to 8.17.1. - [Release notes](https://github.com/websockets/ws/releases) - [Commits](https://github.com/websockets/ws/compare/8.14.2...8.17.1) --- updated-dependencies: - dependency-name: ws dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 1d682d4..6d51955 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4538,9 +4538,9 @@ "dev": true }, "node_modules/ws": { - "version": "8.14.2", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.14.2.tgz", - "integrity": "sha512-wEBG1ftX4jcglPxgFCMJmZ2PLtSbJ2Peg6TmpJFTbe9GZYOQCDPdMYu/Tm0/bGZkw8paZnJY45J4K2PZrLYq8g==", + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.17.1.tgz", + "integrity": "sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==", "dev": true, "engines": { "node": ">=10.0.0" From 47a182a4d4ffe030a5a1c15f57eaf0e78a445dff Mon Sep 17 00:00:00 2001 From: Jeff Williams Date: Sun, 23 Jun 2024 12:32:18 -0700 Subject: [PATCH 5/5] chore(deps): update lockfile --- package-lock.json | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/package-lock.json b/package-lock.json index 6d51955..b0af52b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1236,12 +1236,12 @@ } }, "node_modules/braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", "dev": true, "dependencies": { - "fill-range": "^7.0.1" + "fill-range": "^7.1.1" }, "engines": { "node": ">=8" @@ -1655,9 +1655,9 @@ "dev": true }, "node_modules/ejs": { - "version": "3.1.9", - "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.9.tgz", - "integrity": "sha512-rC+QVNMJWv+MtPgkt0y+0rVEIdbtxVADApW9JXrUVlzHetgcyczP/E7DJmWJ4fJCZF2cPcBk0laWO9ZHMG3DmQ==", + "version": "3.1.10", + "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz", + "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==", "dev": true, "dependencies": { "jake": "^10.8.5" @@ -2213,9 +2213,9 @@ } }, "node_modules/fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", "dev": true, "dependencies": { "to-regex-range": "^5.0.1" @@ -3781,12 +3781,12 @@ "dev": true }, "node_modules/pug": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/pug/-/pug-3.0.2.tgz", - "integrity": "sha512-bp0I/hiK1D1vChHh6EfDxtndHji55XP/ZJKwsRqrz6lRia6ZC2OZbdAymlxdVFwd1L70ebrVJw4/eZ79skrIaw==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/pug/-/pug-3.0.3.tgz", + "integrity": "sha512-uBi6kmc9f3SZ3PXxqcHiUZLmIXgfgWooKWXcwSGwQd2Zi5Rb0bT14+8CJjJgI8AB+nndLaNgHGrcc6bPIB665g==", "dev": true, "dependencies": { - "pug-code-gen": "^3.0.2", + "pug-code-gen": "^3.0.3", "pug-filters": "^4.0.0", "pug-lexer": "^5.0.1", "pug-linker": "^4.0.0", @@ -3808,25 +3808,25 @@ } }, "node_modules/pug-code-gen": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/pug-code-gen/-/pug-code-gen-3.0.2.tgz", - "integrity": "sha512-nJMhW16MbiGRiyR4miDTQMRWDgKplnHyeLvioEJYbk1RsPI3FuA3saEP8uwnTb2nTJEKBU90NFVWJBk4OU5qyg==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/pug-code-gen/-/pug-code-gen-3.0.3.tgz", + "integrity": "sha512-cYQg0JW0w32Ux+XTeZnBEeuWrAY7/HNE6TWnhiHGnnRYlCgyAUPoyh9KzCMa9WhcJlJ1AtQqpEYHc+vbCzA+Aw==", "dev": true, "dependencies": { "constantinople": "^4.0.1", "doctypes": "^1.1.0", "js-stringify": "^1.0.2", "pug-attrs": "^3.0.0", - "pug-error": "^2.0.0", - "pug-runtime": "^3.0.0", + "pug-error": "^2.1.0", + "pug-runtime": "^3.0.1", "void-elements": "^3.1.0", "with": "^7.0.0" } }, "node_modules/pug-error": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/pug-error/-/pug-error-2.0.0.tgz", - "integrity": "sha512-sjiUsi9M4RAGHktC1drQfCr5C5eriu24Lfbt4s+7SykztEOwVZtbFk1RRq0tzLxcMxMYTBR+zMQaG07J/btayQ==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/pug-error/-/pug-error-2.1.0.tgz", + "integrity": "sha512-lv7sU9e5Jk8IeUheHata6/UThZ7RK2jnaaNztxfPYUY+VxZyk/ePVaNZ/vwmH8WqGvDz3LrNYt/+gA55NDg6Pg==", "dev": true }, "node_modules/pug-filters": {