angular - angular4.x docs for offline reading -


i wanted know how angular 4.x docs offline.

i have cloned angular repo github. ran yarn aio directory(as mentioned in readme).

however gives me following error

yarn install v0.27.5 [1/4] resolving packages... success up-to-date. $ uglifyjs node_modules/lunr/lunr.js -c -m -o src/assets/js/lunr.min.js --source-map fs.js:652   return binding.open(pathmodule._makelong(path), stringtoflags(flags), mode);                  ^  typeerror: path must string or buffer     @ object.fs.opensync (fs.js:652:18)     @ object.fs.writefilesync (fs.js:1299:33)     @ /users/apple/code/angular/aio/node_modules/directory-encoder/node_modules/uglify-js/bin/uglifyjs:311:12     @ /users/apple/code/angular/aio/node_modules/directory-encoder/node_modules/async/lib/async.js:188:33     @ /users/apple/code/angular/aio/node_modules/directory-encoder/node_modules/uglify-js/bin/uglifyjs:254:9     @ trytostring (fs.js:513:3)     @ fsreqwrap.readfileafterclose [as oncomplete] (fs.js:501:12) error command failed exit code 1. info visit https://yarnpkg.com/en/docs/cli/install documentation command. 

then ran yarn docs , gave me following output:

yarn docs v0.27.5  $ rimraf src/generated/{docs,*.json} $ dgeni ./tools/transforms/angular.io-package info:    running processor: readfilesprocessor info:    running processor: extractjsdoccommentsprocessor info:    running processor: collectexamples info:    running processor: readtypescriptmodules info:    running processor: linkinheriteddocs info:    running processor: parsetagsprocessor info:    running processor: extracttagsprocessor info:    running processor: codenameprocessor info:    running processor: createoverviewdump info:    running processor: convertprivateclassestointerfacesprocessor info:    running processor: mergedecoratordocs info:    running processor: extractdecoratedclassesprocessor info:    running processor: markbarredodocsasprivate info:    running processor: computeidsprocessor info:    running processor: filtercontaineddocs info:    running processor: filterprivatedocs info:    running processor: simplifymemberanchors info:    running processor: computepathsprocessor info:    running processor: generateapilistdoc info:    running processor: addnotyetdocumentedproperty info:    running processor: matchupdirectivedecorators info:    running processor: processnavigationmap info:    running processor: renderdocsprocessor info:    running processor: unescapecommentsprocessor info:    running processor: inlinetagprocessor info:    running processor: renderexamples info:    running processor: copycontentassetsprocessor info:    running processor: postprocesshtml info:    running processor: computesearchtitleprocessor info:    running processor: generatekeywordsprocessor info:    running processor: checkunbalancedbackticks info:    running processor: fixinternaldocumentlinks info:    running processor: checkanchorlinksprocessor warn:    dangling links found in "guide/aot-compiler.json":  - generated/zips/toh-pt6/toh-pt6.zip warn:    dangling links found in "guide/quickstart.json":  - generated/zips/cli-quickstart/cli-quickstart.zip warn:    dangling links found in "guide/webpack.json":  - generated/zips/webpack/webpack.zip warn:    dangling links found in "docs.json":  - generated/live-examples/quickstart/eplnkr.html error:   error: 4 unmatched links     @ object.$process (/users/apple/code/angular/aio/node_modules/dgeni-packages/base/processors/checkanchorlinks.js:106:17)     @ /users/apple/code/angular/aio/node_modules/dgeni/lib/dgeni.js:179:54     @ _fulfilled (/users/apple/code/angular/aio/node_modules/q/q.js:834:54)     @ self.promisedispatch.done (/users/apple/code/angular/aio/node_modules/q/q.js:863:30)     @ promise.promise.promisedispatch (/users/apple/code/angular/aio/node_modules/q/q.js:796:13)     @ /users/apple/code/angular/aio/node_modules/q/q.js:604:44     @ runsingle (/users/apple/code/angular/aio/node_modules/q/q.js:137:13)     @ flush (/users/apple/code/angular/aio/node_modules/q/q.js:125:13)     @ _combinedtickcallback (internal/process/next_tick.js:67:7)     @ process._tickcallback (internal/process/next_tick.js:98:9) error:   error processing docs:  error: 4 unmatched links     @ object.$process (/users/apple/code/angular/aio/node_modules/dgeni-packages/base/processors/checkanchorlinks.js:106:17)     @ /users/apple/code/angular/aio/node_modules/dgeni/lib/dgeni.js:179:54     @ _fulfilled (/users/apple/code/angular/aio/node_modules/q/q.js:834:54)     @ self.promisedispatch.done (/users/apple/code/angular/aio/node_modules/q/q.js:863:30)     @ promise.promise.promisedispatch (/users/apple/code/angular/aio/node_modules/q/q.js:796:13)     @ /users/apple/code/angular/aio/node_modules/q/q.js:604:44     @ runsingle (/users/apple/code/angular/aio/node_modules/q/q.js:137:13)     @ flush (/users/apple/code/angular/aio/node_modules/q/q.js:125:13)     @ _combinedtickcallback (internal/process/next_tick.js:67:7)     @ process._tickcallback (internal/process/next_tick.js:98:9) /users/apple/code/angular/aio/node_modules/q/q.js:155                 throw e;                 ^  error: 4 unmatched links     @ object.$process (/users/apple/code/angular/aio/node_modules/dgeni-packages/base/processors/checkanchorlinks.js:106:17)     @ /users/apple/code/angular/aio/node_modules/dgeni/lib/dgeni.js:179:54     @ _fulfilled (/users/apple/code/angular/aio/node_modules/q/q.js:834:54)     @ self.promisedispatch.done (/users/apple/code/angular/aio/node_modules/q/q.js:863:30)     @ promise.promise.promisedispatch (/users/apple/code/angular/aio/node_modules/q/q.js:796:13)     @ /users/apple/code/angular/aio/node_modules/q/q.js:604:44     @ runsingle (/users/apple/code/angular/aio/node_modules/q/q.js:137:13)     @ flush (/users/apple/code/angular/aio/node_modules/q/q.js:125:13)     @ _combinedtickcallback (internal/process/next_tick.js:67:7)     @ process._tickcallback (internal/process/next_tick.js:98:9) error command failed exit code 1. 

so know way around it? wanted docs offline reading.

edit: following @gavlan's response , downgrading yarn v0.24.6, here output:

yarn install v0.24.6 [1/4] 🔍  resolving packages... success up-to-date. $ uglifyjs node_modules/lunr/lunr.js -c -m -o src/assets/js/lunr.min.js --source-map ✨  done in 2.75s. 

hence running yarn gives no error , executes fine.

however running `yarn docs still gives error

yarn docs v0.24.6 $ rimraf src/generated/{docs,*.json} $ dgeni ./tools/transforms/angular.io-package info:    running processor: readfilesprocessor info:    running processor: extractjsdoccommentsprocessor info:    running processor: collectexamples info:    running processor: readtypescriptmodules info:    running processor: linkinheriteddocs info:    running processor: parsetagsprocessor info:    running processor: extracttagsprocessor info:    running processor: codenameprocessor info:    running processor: createoverviewdump info:    running processor: convertprivateclassestointerfacesprocessor info:    running processor: mergedecoratordocs info:    running processor: extractdecoratedclassesprocessor info:    running processor: markbarredodocsasprivate info:    running processor: computeidsprocessor info:    running processor: filtercontaineddocs info:    running processor: filterprivatedocs info:    running processor: simplifymemberanchors info:    running processor: computepathsprocessor info:    running processor: generateapilistdoc info:    running processor: addnotyetdocumentedproperty info:    running processor: matchupdirectivedecorators info:    running processor: processnavigationmap info:    running processor: renderdocsprocessor info:    running processor: unescapecommentsprocessor info:    running processor: inlinetagprocessor info:    running processor: renderexamples info:    running processor: copycontentassetsprocessor info:    running processor: postprocesshtml info:    running processor: computesearchtitleprocessor info:    running processor: generatekeywordsprocessor info:    running processor: checkunbalancedbackticks info:    running processor: fixinternaldocumentlinks info:    running processor: checkanchorlinksprocessor warn:    dangling links found in "guide/aot-compiler.json":  - generated/zips/toh-pt6/toh-pt6.zip warn:    dangling links found in "guide/quickstart.json":  - generated/zips/cli-quickstart/cli-quickstart.zip warn:    dangling links found in "guide/webpack.json":  - generated/zips/webpack/webpack.zip warn:    dangling links found in "docs.json":  - generated/live-examples/quickstart/eplnkr.html error:   error: 4 unmatched links     @ object.$process (/users/apple/code/angular/aio/node_modules/dgeni-packages/base/processors/checkanchorlinks.js:106:17)     @ /users/apple/code/angular/aio/node_modules/dgeni/lib/dgeni.js:179:54     @ _fulfilled (/users/apple/code/angular/aio/node_modules/q/q.js:834:54)     @ self.promisedispatch.done (/users/apple/code/angular/aio/node_modules/q/q.js:863:30)     @ promise.promise.promisedispatch (/users/apple/code/angular/aio/node_modules/q/q.js:796:13)     @ /users/apple/code/angular/aio/node_modules/q/q.js:604:44     @ runsingle (/users/apple/code/angular/aio/node_modules/q/q.js:137:13)     @ flush (/users/apple/code/angular/aio/node_modules/q/q.js:125:13)     @ _combinedtickcallback (internal/process/next_tick.js:131:7)     @ process._tickcallback (internal/process/next_tick.js:180:9) error:   error processing docs:  error: 4 unmatched links     @ object.$process (/users/apple/code/angular/aio/node_modules/dgeni-packages/base/processors/checkanchorlinks.js:106:17)     @ /users/apple/code/angular/aio/node_modules/dgeni/lib/dgeni.js:179:54     @ _fulfilled (/users/apple/code/angular/aio/node_modules/q/q.js:834:54)     @ self.promisedispatch.done (/users/apple/code/angular/aio/node_modules/q/q.js:863:30)     @ promise.promise.promisedispatch (/users/apple/code/angular/aio/node_modules/q/q.js:796:13)     @ /users/apple/code/angular/aio/node_modules/q/q.js:604:44     @ runsingle (/users/apple/code/angular/aio/node_modules/q/q.js:137:13)     @ flush (/users/apple/code/angular/aio/node_modules/q/q.js:125:13)     @ _combinedtickcallback (internal/process/next_tick.js:131:7)     @ process._tickcallback (internal/process/next_tick.js:180:9) /users/apple/code/angular/aio/node_modules/q/q.js:155                 throw e;                 ^  error: 4 unmatched links     @ object.$process (/users/apple/code/angular/aio/node_modules/dgeni-packages/base/processors/checkanchorlinks.js:106:17)     @ /users/apple/code/angular/aio/node_modules/dgeni/lib/dgeni.js:179:54     @ _fulfilled (/users/apple/code/angular/aio/node_modules/q/q.js:834:54)     @ self.promisedispatch.done (/users/apple/code/angular/aio/node_modules/q/q.js:863:30)     @ promise.promise.promisedispatch (/users/apple/code/angular/aio/node_modules/q/q.js:796:13)     @ /users/apple/code/angular/aio/node_modules/q/q.js:604:44     @ runsingle (/users/apple/code/angular/aio/node_modules/q/q.js:137:13)     @ flush (/users/apple/code/angular/aio/node_modules/q/q.js:125:13)     @ _combinedtickcallback (internal/process/next_tick.js:131:7)     @ process._tickcallback (internal/process/next_tick.js:180:9) error command failed exit code 1. 

looks due bug in yarn@>=0.25.4 may install wrong versions in node_mdules/.bin/. has been fixed yarnpkg/yarn#3877 , should included in 0.28.1 release.

try updating yarn , run command again. more info can check official issue in angular project


Comments