{"id":22428485,"url":"https://github.com/momsfriendlydevco/doop-docs","last_synced_at":"2025-06-25T09:38:57.703Z","repository":{"id":57109327,"uuid":"355356674","full_name":"MomsFriendlyDevCo/doop-docs","owner":"MomsFriendlyDevCo","description":"Documentation backend for Doop","archived":false,"fork":false,"pushed_at":"2023-04-20T00:31:03.000Z","size":202,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-18T14:54:29.520Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MomsFriendlyDevCo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-06T23:32:42.000Z","updated_at":"2022-02-04T00:38:09.000Z","dependencies_parsed_at":"2024-08-23T20:24:01.949Z","dependency_job_id":"1987cb47-ca5b-441b-a612-88b0646faee1","html_url":"https://github.com/MomsFriendlyDevCo/doop-docs","commit_stats":{"total_commits":73,"total_committers":3,"mean_commits":"24.333333333333332","dds":0.273972602739726,"last_synced_commit":"19ec605539474b60212fc758107668768beac114"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MomsFriendlyDevCo/doop-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MomsFriendlyDevCo","download_url":"https://codeload.github.com/MomsFriendlyDevCo/doop-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MomsFriendlyDevCo%2Fdoop-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261846086,"owners_count":23218707,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-12-05T20:14:56.865Z","updated_at":"2025-06-25T09:38:57.669Z","avatar_url":"https://github.com/MomsFriendlyDevCo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"@DOOP/Docs\n==================\nDoop documentation module\n\nThis module generally lives inside a build script.\n\n\n```javascript\n/**\n* Scan files for inline comments and build documentation \n*/\nlet gulp = require('gulp');\nlet {documenter} = require('@doop/docs');\n\ngulp.task('build.vue', ['load:app', 'load:app.db', 'load:app.git'], ()=\u003e\n\tdocumenter({\n\t\tlog: gulp.log, // Fancy logging output\n\t})\n);\n```\n\n\nAPI\n===\nThis module exports only one sub-module currently, the `documenter` function.\n\n\nDocumenter(options)\n-----------------\nScan project for inline documentation and process placing resulting files in the `dist/docs` directory within the parent Doop project.\n\nThis function expects the Doop global `app` to be available and it will use it for pathing, config information.\n\nOptions:\n\n| Name            | Type       | Default          | Description                                                                      |\n|-----------------|------------|------------------|----------------------------------------------------------------------------------|\n| `widdershins`        | `Object`   | `{ codeSamples: true, user_templates: '../templates/widdershins' }` | Upstream widdershins config, see notes                                             |\n| `shins`   | `Object`   | `shins: { inline: true, logo: './assets/logo/logo.png', 'logo-url': app.config.publicUrl },` | Upstream shins config, see notes                            |\n| `log`           | `function` | `console.log`    | Logging function for any output                                                  |\n| `responseTypes` | `Object` | `{ File: { type: 'application/octet-stream', schema: { type: 'string', format: 'binary' }}}` | Predefined content-type and schema for `@returns`\n\n\nUsage\n=============\n\n* `@returns {Object}` where a collection is available will automagically be replaced with `@returns {ModelName}`\n* `@returns {ModelName}` will create an `application/json` response with schema properties matching that of the Mongo collection.\n\n\nPredefined Response Types\n-------------------------\n\nThese types may be used in `@returns {Type}` and allow association of a response with a content-type and schema.\n\n| Name            | Type       | Schema Type      | Schema Format    |\n|-----------------|------------|------------------|------------------|\n| `Stream`        | `application/octet-stream` | `string` | `binary` |\n| `File`          | `application/octet-stream` | `string` | `binary` |\n| `PDF`           | `application/pdf` | `string` | `binary` |\n| `GIF`           | `image/gif` | `string` | `base64` |\n| `JPEG`          | `image/jpeg` | `string` | `base64` |\n| `PNG`           | `image/png` | `string` | `base64` |\n| `String`        | `text/plain` | `string` | |\n| `HTML`          | `text/html` | `string` | `html` |\n| `Date`          | `text/plain` | `string` | `date` |\n| `DateTime`      | `text/plain` | `string` | `date-time` |\n| `Array`         | `application/json` | `array` | |\n| `Object`        | `application/json` | `object` | |\n\n\n**NOTES:**\n\n* https://github.com/Mermade/widdershins#options\n* https://github.com/Mermade/shins\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmomsfriendlydevco%2Fdoop-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmomsfriendlydevco%2Fdoop-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmomsfriendlydevco%2Fdoop-docs/lists"}