{"id":14973522,"url":"https://github.com/suhdev/suh-dgeni-ngdocs","last_synced_at":"2026-03-03T11:31:47.207Z","repository":{"id":32402599,"uuid":"35979282","full_name":"suhdev/suh-dgeni-ngdocs","owner":"suhdev","description":"A node module that facilitates creating ngdocs documentation similar to whats currently used on AngularJS website. ","archived":false,"fork":false,"pushed_at":"2015-06-03T10:01:50.000Z","size":4388,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-19T03:54:47.219Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/suhdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-20T23:17:31.000Z","updated_at":"2018-07-19T13:17:39.000Z","dependencies_parsed_at":"2022-09-17T17:10:09.108Z","dependency_job_id":null,"html_url":"https://github.com/suhdev/suh-dgeni-ngdocs","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/suhdev/suh-dgeni-ngdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suhdev%2Fsuh-dgeni-ngdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suhdev%2Fsuh-dgeni-ngdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suhdev%2Fsuh-dgeni-ngdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suhdev%2Fsuh-dgeni-ngdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/suhdev","download_url":"https://codeload.github.com/suhdev/suh-dgeni-ngdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suhdev%2Fsuh-dgeni-ngdocs/sbom","scorecard":{"id":857695,"data":{"date":"2025-08-18","repo":{"name":"github.com/suhdev/suh-dgeni-ngdocs","commit":"db0cdb95e43f7f388ab48a1f78963e298ebea9ab"},"scorecard":{"version":"v5.2.1-41-g40576783","commit":"40576783fda6698350fcbbeaea760ff827433034"},"score":2.6,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#cii-best-practices"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#binary-artifacts"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#security-policy"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#signed-releases"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-24T00:20:08.095Z","repository_id":32402599,"created_at":"2025-08-24T00:20:08.095Z","updated_at":"2025-08-24T00:20:08.095Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30042931,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T10:53:31.691Z","status":"ssl_error","status_checked_at":"2026-03-03T10:53:22.041Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:48:54.196Z","updated_at":"2026-03-03T11:31:47.190Z","avatar_url":"https://github.com/suhdev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# suh-dgeni-ngdocs\n\nA package to generate ngdocs using Dgeni similar to whats currently used on AngularJS website. \n\n## Installation \n\n### Using NPM \n\n```sh\n\n\tnpm install suh-dgeni-docs --save-dev\n\n```\n\n### Clone GitHub Reposotiry \n\n\n```sh\n\n\tgit clone https://github.com/suhdev/suh-dgeni-ngdocs \n\n```\n\n\n## Usage\n\nFirst, install the ```canonical-path``` module using NPM, the module is used to generate absolute paths for your source files: \n\n```sh\n\n\tnpm install canonical-path --save-dev\n\n```\n\nNext, create a new javascript file as follows: \n\n```javascript\n\n\tvar path = require('path'),\n\t\tfs = require('fs'),\n\t\tngdocs = require('suh-dgeni-ngdocs');\n\n\n\tngdocs.generate({\n\tdefaultDeployment:{\n\t\tname:'default',\n\t\tmeta:{\n\t\t\tdescription:'just a test',\n\t\t},\n\t\tnavigation:{\n\t\t\ttop:{\n\t\t\t\t//Navigation items for the top navigation \n\t\t\t\tnavItems:[{\n            \t\ttype:'divider',\n          \t\t},\n          \t\t{\n\t\t            type:'dropdown',\n\t\t            disabled:true,\n\t\t            label:'TestModule Documentation',\n\t\t            url:'#',\n\t\t            menu:[{\n\t\t\t              \tlabel:'API Reference',\n\t\t\t              \turl:'api'\n\t\t\t            },{\n\t\t\t              \tlabel:'Guides',\n\t\t\t              \turl:'guide'\n\t\t\t            },{\n\t\t\t            \tlabel:'Suhail',\n\t\t\t            \turl:'suhail'\n\t\t\t            }\n\t\t\t        ]\n          \t\t},\n          \t\t{\n          \t\t\ttype:'divider'\n          \t\t}]\n\t\t\t}\n\t\t},\n\t\t//add any javascript files to be included in the documentation, \n\t\t//usually this includes youre compiled (minimized angular code). \n\t\t//also note that you need to pass the source to the ```path.resolve``` \n\t\t//function to generate the absolute URL. \n\t\tscripts:[path.resolve('./app.min.js')] \n\t},\n\t\t\t//base path to your source \n\t\t\tbasePath:path.resolve('testsrc'),\n\t\t\t//add your source paths patterns \n\t\t\tsourceFiles:[\n\t\t\t\t'*.js',\n\t\t\t\t'**/*.ngdoc'],\n\t\t\t//still under development, ideally here this will be extracted from code\n\t\t\t//to extract new sections in the documentation other than the predefined ones\n\t\t\tAREA_NAMES:{\n\t\t\t\tsuhail:'Suhail Abood',\n\t\t\t},\n\t\t\t//define the output path for your documentation\n\t\t\t//again note that we're passing the folder to the \n\t\t\t//```path.resolve``` function \n\t\t\toutputFolder:path.resolve('generated'),\n\t\t\t//home page information \n\t\t\thomePage:{\n\t\t\t\tdata:{\n\t\t\t\t\t//title of the home page\n\t\t\t\t\ttitle:'Suhail Abood Library',\n\t\t\t\t\t//desctiption (content of the home page, this can include markdown content as well)\n\t\t\t\t\t//you can pass in the content of the ```README.md``` \n\t\t\t\t\tdescription:fs.readFileSync('./README.md').toString(),\n\t\t\t\t\t//still under development, ideally this will be used to add\n\t\t\t\t\t//dependencies section with full details about each dependency. \n\t\t\t\t\tdependencies:[{\n\t\t\t\t\t\tname:'angular',\n\t\t\t\t\t\tversion:'1.3.15'\n\t\t\t\t\t},{\n\t\t\t\t\t\tname:'jquery',\n\t\t\t\t\t\tversion:'2.1.13'\n\t\t\t\t\t}]\n\t\t\t\t}\n\t\t\t},\n\t\t\tlogger:{\n\t\t\t\t//set the ```Dgeni``` logger level (info|warn|debug|error)\n\t\t\t\tlevel:null\n\t\t\t},\n\t\t\textraData:{\n\t\t\t\t//still under development, this object literal is passed on to \n\t\t\t\t//all documents, all partials, and still looking into the potential\n\t\t\t\t//usage of such access\n\t\t\t\tangular:'1.3.15',\n\t\t\t\tjquery:'2.1.13',\n\t\t\t\tname:'Suhail Abood',\n\t\t\t\tmodule:{\n\t\t\t\t\tversion:'v1.0.0',\n\t\t\t\t\tfile:'suhail.js',\n\t\t\t\t\tminifiedFile:'suhail.min.js'\n\t\t\t\t}\n\t\t\t}\n\t\t});\n\n```\n\nThe same code can be used within a gulp task as follows: \n\n```javascript\n\nvar gulp = require('gulp'); \n\n//assuming there is a task (```concat-js```) to concatenate the source \ngulp.task('ngdocs',['concat-js'], function(){\n\t//wrap in try catch to make sure it doesn't break the flow of task execution \n\t//even if it fails. \n\ttry{\n\n\tngdocs.generate({\n\tdefaultDeployment:{\n\t\tname:'default',\n\t\tmeta:{\n\t\t\tdescription:'just a test',\n\t\t},\n\t\tnavigation:{\n\t\t\ttop:{\n\t\t\t\t//Navigation items for the top navigation \n\t\t\t\tnavItems:[{\n            \t\ttype:'divider',\n          \t\t},\n          \t\t{\n\t\t            type:'dropdown',\n\t\t            disabled:true,\n\t\t            label:'TestModule Documentation',\n\t\t            url:'#',\n\t\t            menu:[{\n\t\t\t              \tlabel:'API Reference',\n\t\t\t              \turl:'api'\n\t\t\t            },{\n\t\t\t              \tlabel:'Guides',\n\t\t\t              \turl:'guide'\n\t\t\t            },{\n\t\t\t            \tlabel:'Suhail',\n\t\t\t            \turl:'suhail'\n\t\t\t            }\n\t\t\t        ]\n          \t\t},\n          \t\t{\n          \t\t\ttype:'divider'\n          \t\t}]\n\t\t\t}\n\t\t},\n\t\t//add any javascript files to be included in the documentation, \n\t\t//usually this includes youre compiled (minimized angular code). \n\t\t//also note that you need to pass the source to the ```path.resolve``` \n\t\t//function to generate the absolute URL. \n\t\tscripts:[path.resolve('./app.min.js')] \n\t},\n\t\t\t//base path to your source \n\t\t\tbasePath:path.resolve('testsrc'),\n\t\t\t//add your source paths patterns \n\t\t\tsourceFiles:[\n\t\t\t\t'*.js',\n\t\t\t\t'**/*.ngdoc'],\n\t\t\t//still under development, ideally here this will be extracted from code\n\t\t\t//to extract new sections in the documentation other than the predefined ones\n\t\t\tAREA_NAMES:{\n\t\t\t\tsuhail:'Suhail Abood',\n\t\t\t},\n\t\t\t//define the output path for your documentation\n\t\t\t//again note that we're passing the folder to the \n\t\t\t//```path.resolve``` function \n\t\t\toutputFolder:path.resolve('generated'),\n\t\t\t//home page information \n\t\t\thomePage:{\n\t\t\t\tdata:{\n\t\t\t\t\t//title of the home page\n\t\t\t\t\ttitle:'Suhail Abood Library',\n\t\t\t\t\t//desctiption (content of the home page, this can include markdown content as well)\n\t\t\t\t\t//you can pass in the content of the ```README.md``` \n\t\t\t\t\tdescription:fs.readFileSync('./README.md').toString(),\n\t\t\t\t\t//still under development, ideally this will be used to add\n\t\t\t\t\t//dependencies section with full details about each dependency. \n\t\t\t\t\tdependencies:[{\n\t\t\t\t\t\tname:'angular',\n\t\t\t\t\t\tversion:'1.3.15'\n\t\t\t\t\t},{\n\t\t\t\t\t\tname:'jquery',\n\t\t\t\t\t\tversion:'2.1.13'\n\t\t\t\t\t}]\n\t\t\t\t}\n\t\t\t},\n\t\t\tlogger:{\n\t\t\t\t//set the ```Dgeni``` logger level (info|warn|debug|error)\n\t\t\t\tlevel:null\n\t\t\t},\n\t\t\textraData:{\n\t\t\t\t//still under development, this object literal is passed on to \n\t\t\t\t//all documents, all partials, and still looking into the potential\n\t\t\t\t//usage of such access\n\t\t\t\tangular:'1.3.15',\n\t\t\t\tjquery:'2.1.13',\n\t\t\t\tname:'Suhail Abood',\n\t\t\t\tmodule:{\n\t\t\t\t\tversion:'v1.0.0',\n\t\t\t\t\tfile:'suhail.js',\n\t\t\t\t\tminifiedFile:'suhail.min.js'\n\t\t\t\t}\n\t\t\t}\n\t\t}); \n\t\t}catc(err){\n\t\t\tconsole.log(err);\n\t\t}\n});\n\n```\n\n## Custom tags\n1. @todo \n\tThe tag now supports a type it can be used in the following syntax:\n\n\t```javascript\n\t/** \n\t * @ngdoc module\n\t * @name BlahBlah\n\t * @module BlahBlah\n\t * @todo {urgent} this is urgent \n\t * @todo {warn} this is not urgent \n\t * @todo {urgent} this is also urgent\n\t * @todo {urgent|next|warn|important|primary|success|danger} {label} todo text\n\t * @description\n\t * this is just a description\n\t */\n\n\t```\n\n\tAlso, note that the todo will be grouped by their type and then presented. \n\n\tIf no type is provided it will default to a `primary` i.e. \n\n\t@todo todo text \n\n2. @note \n\tThe tag now supports a type as in the following syntax:\n\n\t```javascript\n\t/** \n\t * @ngdoc module\n\t * @name BlahBlah\n\t * @module BlahBlah\n\t * @note {urgent} this is urgent \n\t * @note {warn} this is not urgent \n\t * @note {urgent} this is also urgent\n\t * @note {urgent|next|warn|important|primary|success|danger} todo text\n\t * @description\n\t * this is just a description\n\t */\n\n\t```\n\n3. @briefdesc\n\tThis tag allows for adding a special description to show up on summary pages \n\trather than using the first paragraph of the description tag. \n\n\t```javascript\n\t/** \n\t * @ngdoc module\n\t * @name BlahBlah\n\t * @module BlahBlah\n\t * @todo {urgent} this is urgent \n\t * @todo {warn} this is not urgent \n\t * @todo {urgent} this is also urgent\n\t * @todo {urgent|next|warn|important|primary|success|danger} todo text\n\t * @description\n\t * this is just a description\n\t */\n\n\t```\n\n## Attribution \n\nThis package is basically an extension to the ```dgeni-packages``` module (built on top of it),in which I replaced the templates with customized ones,\nI've also included some extra tags and extended some of the previously defined ones. \n\nA full list of the tags will be added here as well as in the documentation (as soon as I finish writing them). \n\nSo, this is to thank everyone who contributed to the ```dgeni-packages```, which can be accessed on [dgeni-packages](https://github.com/angular/dgeni-packages), reading through that code was quiet amusing, and I loved the architecture of the module. It does lack documentation, but the code is almost self explanatory. \n\nI would also like to thank the guys behind UIKit, which can be accessed on [UIKit](http://getuikit.com), as I've used their framework to in the templates (because I suck at design), and I just fall in love with their framework. \n\n\n## NEXT\n\nI'm currently working on lots of additions and fixing, however, the base code will not change, and thus the module is ready for usage now, anything else\nwill either be a bug fix or an extension that should be backward compatible. Some of these are: \n\n1. Using own templates. \n2. Smarter linkage with github and git repository.\n3. Lots of minor bug fixes that I've already noted down. \n\nI'm compiling a list of the upcoming additions and I'll add them all here as soon as I have a my roadmap ready. Some of these are:\n\n\nSuhail Abood\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuhdev%2Fsuh-dgeni-ngdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuhdev%2Fsuh-dgeni-ngdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuhdev%2Fsuh-dgeni-ngdocs/lists"}