├── .gitignore ├── Gruntfile.js ├── LICENSE ├── README.md ├── docs ├── dgeni-example.js └── templates │ └── common.template.html ├── gulpfile.js ├── package.json └── src ├── app.js ├── do-not-read.js └── script.js /.gitignore: -------------------------------------------------------------------------------- 1 | lib-cov 2 | *.seed 3 | *.log 4 | *.csv 5 | *.dat 6 | *.out 7 | *.pid 8 | *.gz 9 | 10 | pids 11 | logs 12 | results 13 | 14 | npm-debug.log 15 | node_modules 16 | 17 | build -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | var Dgeni = require('dgeni'); 2 | 3 | module.exports = function(grunt) { 4 | 5 | grunt.registerTask('dgeni', 'Generate docs via dgeni.', function() { 6 | var done = this.async(); 7 | var dgeni = new Dgeni([require('./docs/dgeni-example')]); 8 | dgeni.generate().then(done); 9 | }); 10 | 11 | grunt.registerTask('default', ['dgeni']); 12 | 13 | }; -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # What is Dgeni? 2 | 3 | [Dgeni](https://github.com/angular/dgeni) is a documentation generator developed by the 4 | [Angular team](https://github.com/angular). Ironically it lacks documentation right now, so we 5 | try to develop a very simple step-by-step-guide here, until a better documentation is 6 | available. Please share and fork this repo. 7 | 8 | Dgeni is currently used in these projects: 9 | - [Angular](https://github.com/angular/angular.js/tree/master/docs) 10 | - [protractor](https://github.com/angular/protractor/tree/master/docs) 11 | - [ionic](https://github.com/driftyco/ionic) 12 | - [famous-angular](https://github.com/Famous/famous-angular) 13 | 14 | # Why should I use Dgeni? 15 | 16 | Dgeni seems to be very flexible, because it has a modular core and its extensibility with 17 | plugins. It seems to be relatively technology agnostic, so it should be good for HTML, CSS and 18 | JS documentation alike. It should be suitable for server components or REST API documentation, 19 | too. With custom plugins you can even create very framework-specific documentation - say treat 20 | controllers and directives similar to native primitives in Angular apps. 21 | 22 | # How do I install Dgeni? 23 | 24 | Install [Node](http://nodejs.org/), if you don't have it allready. After that you can install 25 | Dgeni and an additional module with basic plugins for Dgeni called `dgeni-packages`: 26 | 27 | ```bash 28 | $ npm install --save-dev dgeni dgeni-packages 29 | ``` 30 | 31 | # How can I use Dgeni with Grunt? 32 | 33 | There is no official grunt task but using Dgeni with Grunt is pretty simple. 34 | Just create a custom task in your `Gruntfile.js`: 35 | 36 | ```js 37 | grunt.registerTask('dgeni', 'Generate docs via dgeni.', function() { 38 | var done = this.async(); 39 | var dgeni = new Dgeni([require('./docs/dgeni-example')]); 40 | dgeni.generate().then(done); 41 | }); 42 | ``` 43 | 44 | You can execute this task via: 45 | 46 | ```bash 47 | $ grunt dgeni 48 | ``` 49 | 50 | This task will load a Dgeni package at `docs/dgeni-example.js`, which tells Dgeni what to 51 | generate. 52 | 53 | # How can I use Dgeni with Gulp? 54 | 55 | 56 | Gulp plugins are specifically for file manipulation with streams. Dgeni does not process files 57 | in a stream-like manner so it is not appropriate to build a Gulp plugin. Luckily, the way Gulp 58 | works it is really easy to run Dgeni from a task: 59 | 60 | ```js 61 | gulp.task('dgeni', function() { 62 | var dgeni = new Dgeni([require('./docs/dgeni-example')]); 63 | return dgeni.generate(); 64 | }); 65 | ``` 66 | 67 | You can execute this task via: 68 | 69 | ```bash 70 | $ gulp dgeni 71 | ``` 72 | 73 | This task will load a Dgeni package at `docs/dgeni-example.js`, which tells Dgeni what to 74 | generate. 75 | 76 | # How can I configure Dgeni? 77 | 78 | Dgeni processing is configured by Dgeni Packages. You must provide at least one 79 | Package to tell Dgeni what files to read and how to process them. Check out the `dgeni-example` 80 | package in this project, at `docs/dgeni-example.js`. 81 | 82 | # How does Dgeni work? 83 | 84 | Say we have a `src/` with `app.js` and a `script.js` annotated with jsdocs: 85 | 86 | ```js 87 | // app.js 88 | /** 89 | * @name log 90 | * @description This function logs a string. 91 | */ 92 | 93 | function log() { 94 | console.log('Logging.'); 95 | } 96 | ``` 97 | 98 | ```js 99 | // script.js 100 | /** 101 | * @name helloWorld 102 | * @description This function returns a string. 103 | * 104 | * @returns {string} This string has the value 'Hello World'. 105 | */ 106 | 107 | function helloWorld() { 108 | return 'Hello World'; 109 | } 110 | ``` 111 | 112 | We can tell Dgeni to read these these files and render docs based on nunjucks-templates by 113 | defining our own Dgeni Package: 114 | 115 | ```js 116 | // Canonical path provides a consistent path (i.e. always forward slashes) across different OSes 117 | var path = require('canonical-path'); 118 | 119 | var Package = require('dgeni').Package; 120 | 121 | // Create and export a new Dgeni package called dgeni-example. This package depends upon 122 | // the jsdoc and nunjucks packages defined in the dgeni-packages npm module. 123 | module.exports = new Package('dgeni-example', [ 124 | require('dgeni-packages/jsdoc'), 125 | require('dgeni-packages/nunjucks') 126 | ]) 127 | 128 | // Configure our dgeni-example package. We can ask the Dgeni dependency injector 129 | // to provide us with access to services and processors that we wish to configure 130 | .config(function(log, readFilesProcessor, templateFinder, writeFilesProcessor) { 131 | 132 | // Set logging level 133 | log.level = 'info'; 134 | 135 | // Specify the base path used when resolving relative paths to source and output files 136 | readFilesProcessor.basePath = path.resolve(__dirname, '..'); 137 | 138 | // Specify collections of source files that should contain the documentation to extract 139 | readFilesProcessor.sourceFiles = [ 140 | { 141 | // Process all js files in `src` and its subfolders ... 142 | include: 'src/**/*.js', 143 | // ... except for this one! 144 | exclude: 'src/do-not-read.js', 145 | // When calculating the relative path to these files use this as the base path. 146 | // So `src/foo/bar.js` will have relative path of `foo/bar.js` 147 | basePath: 'src' 148 | } 149 | ]; 150 | 151 | // Add a folder to search for our own templates to use when rendering docs 152 | templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); 153 | 154 | // Specify how to match docs to templates. 155 | // In this case we just use the same static template for all docs 156 | templateFinder.templatePatterns.unshift('common.template.html'); 157 | 158 | // Specify where the writeFilesProcessor will write our generated doc files 159 | writeFilesProcessor.outputFolder = 'build'; 160 | }); 161 | ``` 162 | 163 | We have a single nunjucks template that is used to render the documents. It is stored in 164 | `docs/templates/common.template.html` and looks like this: 165 | 166 | ```html 167 |

{{ doc.codeName }} ({{ doc.outputPath }})

168 |

{{ doc.description }}

169 | 170 | {% if doc.params %} 171 |

Params

172 | 179 | {% endif %} 180 | 181 | {% if doc.returns %} 182 |

Returns

183 |

184 | { {{ doc.returns.typeList }} } - {{ doc.returns.description }} 185 |

186 | {% endif %} 187 | ``` 188 | 189 | When we run Dgeni (say by running the Gulp or Grunt task defined above) you will get the 190 | following files, which refer to each of the jsdoc blocks that were read from the files: 191 | 192 | **greet.html** 193 | ```html 194 |

greet (greet.html)

195 |

Display a greeting

196 | 197 |

Params

198 | 203 | ``` 204 | 205 | **helloWorld.html** 206 | ```html 207 |

helloWorld (helloWorld.html)

208 |

This function returns a string.

209 | 210 |

Returns

211 |

212 | { string } - This string has the value 'Hello World'. 213 |

214 | ``` 215 | 216 | **log.html** 217 | ```html 218 |

log (log.html)

219 |

This function logs a string.

220 | ``` 221 | 222 | **myApp.html** 223 | ```html 224 |

myApp (myApp.html)

225 |

My application

226 | ``` 227 | -------------------------------------------------------------------------------- /docs/dgeni-example.js: -------------------------------------------------------------------------------- 1 | // Canonical path provides a consistent path (i.e. always forward slashes) across different OSes 2 | var path = require('canonical-path'); 3 | 4 | var Package = require('dgeni').Package; 5 | 6 | // Create and export a new Dgeni package called dgeni-example. This package depends upon 7 | // the jsdoc and nunjucks packages defined in the dgeni-packages npm module. 8 | module.exports = new Package('dgeni-example', [ 9 | require('dgeni-packages/jsdoc'), 10 | require('dgeni-packages/nunjucks') 11 | ]) 12 | 13 | // Configure our dgeni-example package. We can ask the Dgeni dependency injector 14 | // to provide us with access to services and processors that we wish to configure 15 | .config(function(log, readFilesProcessor, templateFinder, writeFilesProcessor) { 16 | 17 | // Set logging level 18 | log.level = 'info'; 19 | 20 | // Specify the base path used when resolving relative paths to source and output files 21 | readFilesProcessor.basePath = path.resolve(__dirname, '..'); 22 | 23 | // Specify collections of source files that should contain the documentation to extract 24 | readFilesProcessor.sourceFiles = [ 25 | { 26 | // Process all js files in `src` and its subfolders ... 27 | include: 'src/**/*.js', 28 | // ... except for this one! 29 | exclude: 'src/do-not-read.js', 30 | // When calculating the relative path to these files use this as the base path. 31 | // So `src/foo/bar.js` will have relative path of `foo/bar.js` 32 | basePath: 'src' 33 | } 34 | ]; 35 | 36 | // Add a folder to search for our own templates to use when rendering docs 37 | templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); 38 | 39 | // Specify how to match docs to templates. 40 | // In this case we just use the same static template for all docs 41 | templateFinder.templatePatterns.unshift('common.template.html'); 42 | 43 | // Specify where the writeFilesProcessor will write our generated doc files 44 | writeFilesProcessor.outputFolder = 'build'; 45 | }); -------------------------------------------------------------------------------- /docs/templates/common.template.html: -------------------------------------------------------------------------------- 1 |

{{ doc.codeName }} ({{ doc.outputPath }})

2 |

{{ doc.description }}

3 | 4 | {%- if doc.params %} 5 |

Params

6 | 13 | {%- endif %} 14 | 15 | {%- if doc.returns %} 16 |

Returns

17 |

18 | { {{ doc.returns.typeList }} } - {{ doc.returns.description }} 19 |

20 | {%- endif %} -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | var gulp = require('gulp'); 2 | var Dgeni = require('dgeni'); 3 | 4 | gulp.task('dgeni', function() { 5 | try { 6 | var dgeni = new Dgeni([require('./docs/dgeni-example')]); 7 | return dgeni.generate(); 8 | } catch(x) { 9 | console.log(x.stack); 10 | throw x; 11 | } 12 | }); 13 | 14 | gulp.task('default', ['dgeni']); -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "dgeni-example", 3 | "version": "0.0.0", 4 | "private": true, 5 | "description": "[dgeni](https://github.com/angular/dgeni) is a documentation generator developed by the [Angular team](https://github.com/angular). Ironically it lacks documentation right now, so we try to develop a very simple step-by-step-guide here, until a better documentation is available. Please share and fork this Gist.", 6 | "main": "index.js", 7 | "scripts": { 8 | "test": "echo \"Error: no test specified\" && exit 1" 9 | }, 10 | "repository": { 11 | "type": "git", 12 | "url": "https://github.com/petebacondarwin/dgeni-example.git" 13 | }, 14 | "author": "Pete Bacon Darwin", 15 | "licenses": [ 16 | { 17 | "type": "Apache", 18 | "url": "http://www.apache.org/licenses/LICENSE-2.0.html" 19 | } 20 | ], 21 | "bugs": { 22 | "url": "https://github.com/petebacondarwin/dgeni-example/issues" 23 | }, 24 | "homepage": "https://github.com/petebacondarwin/dgeni-example", 25 | "devDependencies": { 26 | "dgeni": "^0.4.0", 27 | "dgeni-packages": "^0.16.0", 28 | "gulp": "^3.5.6", 29 | "grunt": "^0.4.4", 30 | "canonical-path": "0.0.2" 31 | }, 32 | "contributors": [ 33 | "Pete Bacon Darwin ", 34 | "Donald Pipowitch ", 35 | "sroe ", 36 | "fvanderwielen ", 37 | "Olivier Combe " 38 | ] 39 | } 40 | -------------------------------------------------------------------------------- /src/app.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @description This function logs a string. 3 | */ 4 | function log() { 5 | console.log('Logging.'); 6 | } 7 | 8 | /** 9 | * @description My application 10 | */ 11 | var myApp = { 12 | 13 | /** 14 | * @description Display a greeting 15 | * @param {string} name The name of the person to greet 16 | */ 17 | greet: function(name) { 18 | console.log('hello ' + name); 19 | } 20 | 21 | }; -------------------------------------------------------------------------------- /src/do-not-read.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @description 3 | * This file should not have documents read from it. 4 | */ -------------------------------------------------------------------------------- /src/script.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @description This function returns a string. 3 | * 4 | * @returns {string} This string has the value 'Hello World'. 5 | */ 6 | 7 | function helloWorld() { 8 | return 'Hello World'; 9 | } --------------------------------------------------------------------------------