{"id":18926122,"url":"https://github.com/broccolijs/broccoli-yuidoc","last_synced_at":"2025-04-15T13:32:37.043Z","repository":{"id":17086933,"uuid":"19852079","full_name":"broccolijs/broccoli-yuidoc","owner":"broccolijs","description":"YUIDoc generator for broccoli","archived":false,"fork":false,"pushed_at":"2022-12-06T23:16:23.000Z","size":121,"stargazers_count":6,"open_issues_count":8,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-14T08:18:16.094Z","etag":null,"topics":["broccoli","broccoli-yuidoc","javascript","yuidoc"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"plan3/griffel","license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/broccolijs.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}},"created_at":"2014-05-16T09:57:27.000Z","updated_at":"2020-02-19T07:51:33.000Z","dependencies_parsed_at":"2023-01-11T20:25:53.324Z","dependency_job_id":null,"html_url":"https://github.com/broccolijs/broccoli-yuidoc","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broccolijs%2Fbroccoli-yuidoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broccolijs%2Fbroccoli-yuidoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broccolijs%2Fbroccoli-yuidoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/broccolijs%2Fbroccoli-yuidoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/broccolijs","download_url":"https://codeload.github.com/broccolijs/broccoli-yuidoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249080329,"owners_count":21209509,"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":["broccoli","broccoli-yuidoc","javascript","yuidoc"],"created_at":"2024-11-08T11:14:35.701Z","updated_at":"2025-04-15T13:32:36.811Z","avatar_url":"https://github.com/broccolijs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# broccoli-yuidoc [![Build Status](https://travis-ci.org/broccolijs/broccoli-yuidoc.svg?branch=master)](https://travis-ci.org/broccolijs/broccoli-yuidoc) [![Build status](https://ci.appveyor.com/api/projects/status/bc56n5ukqx9u0u50?svg=true)](https://ci.appveyor.com/project/embercli/broccoli-yuidoc)\n\nThis plugin provides support for generating YUIDoc via a broccoli\npipeline.\n\n## Installation\n\n```\nnpm install --save-dev broccoli-yuidoc\n```\n\n## Configuration\n\nAdditional options related to YUIDoc may be may be passed as an object\n`yuidoc` to `yuidocCompiler`.\nAll of the available options can be found on [YUIDoc's official documentation\npage](https://yui.github.io/yuidoc/args/index.html).\n\nNote: If a `yuidoc.json` file exists in a parent directory, it will be\nused as well.\n\n## Usage\n\n```js\nvar YUIDoc = require('broccoli-yuidoc');\nvar mergeTrees = require('broccoli-merge-trees');\n\n// As with most other broccoli plugins, you can\n// define the base directory of the files you\n// would like documentation generated for as\n// the first paramter, and specify source and\n// destination directories.\n// Custom YUIdoc options is passed as yuidoc.\n\nvar yuidocTree = new YUIDoc(['app'], {\n\tdestDir: 'docs',\n\tyuidoc: {\n\t\t// .. yuidoc option overrides\n\t}\n});\n\n\n// To merge the YUIdoc build tree with, let's say,\n// an ember application tree, use broccoli-mergetrees\nvar applicationTree = mergeTrees([app.toTree(), yuidocTree]);\n\nmodule.exports = applicationTree;\n```\n\nIt's recomended to use `broccoli-merge-trees` to finally produce\na signle tree for broccoli to work on.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbroccolijs%2Fbroccoli-yuidoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbroccolijs%2Fbroccoli-yuidoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbroccolijs%2Fbroccoli-yuidoc/lists"}