|
57 | 57 | There are also tests in the `test-complete` folder. The setup for these is more complicated and can |
58 | 58 | be found in the `Jenkinsfile` file in this repository in the `runE2ETests` function. |
59 | 59 |
|
| 60 | +## Generating documentation |
| 61 | + |
| 62 | +After installing the project dependencies (including the [gulp](http://gulpjs.com/) |
| 63 | +build system), you can build the reference documentation locally from the root |
| 64 | +directory of the marklogic package: |
| 65 | + |
| 66 | + npm run doc |
| 67 | + |
| 68 | +The documentation is generated in the `./doc` gitignore'd directory. The documentation can also be |
| 69 | +accessed online at <https://docs.marklogic.com/jsdoc/index.html>. |
| 70 | + |
60 | 71 | ## Explanation of overrides in package.json |
61 | 72 |
|
62 | 73 | Each override is being documented here so we have some ability in the future to remove an override as needed. |
@@ -86,18 +97,6 @@ glob-parent: "6.0.2" |
86 | 97 | - Why needed: Older versions vulnerable to regex attacks |
87 | 98 | - CVE/Issue: CVE-2020-28469 - ReDoS vulnerability |
88 | 99 |
|
89 | | -jsdoc: "4.0.0" |
90 | | -- Purpose: Fixes high-severity data access vulnerability in older jsdoc versions |
91 | | -- Affects: gulp-jsdoc3 → jsdoc |
92 | | -- Why needed: [email protected] uses older jsdoc with known vulnerabilities |
93 | | -- CVE/Issue: High severity vulnerability in taffydb (jsdoc dependency) |
94 | | - |
95 | | -markdown-it: "14.1.0" |
96 | | -- Purpose: Use latest markdown parser for JSDoc |
97 | | -- Affects: gulp-jsdoc3 → jsdoc → markdown-it |
98 | | -- Why needed: Latest version (no vulnerabilities), handles RFC 7464 parsing |
99 | | -- Note: No newer version available, ensures consistency |
100 | | - |
101 | 100 | minimatch: "5.1.0" |
102 | 101 | - Purpose: Fixes ReDoS (Regular Expression Denial of Service) vulnerability |
103 | 102 | - Affects: mocha, gulp-mocha, and other build tools |
|
0 commit comments