{"id":15849488,"url":"https://github.com/osukaa/dogbane-generator","last_synced_at":"2025-08-23T14:36:28.616Z","repository":{"id":141461832,"uuid":"38880063","full_name":"osukaa/dogbane-generator","owner":"osukaa","description":"A html generator based on the API Blueprint JSON format.","archived":false,"fork":false,"pushed_at":"2015-07-11T03:28:44.000Z","size":120,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-01T18:28:28.172Z","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/osukaa.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-07-10T12:49:14.000Z","updated_at":"2015-08-06T00:45:01.000Z","dependencies_parsed_at":"2023-03-13T02:08:39.919Z","dependency_job_id":null,"html_url":"https://github.com/osukaa/dogbane-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/osukaa/dogbane-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osukaa%2Fdogbane-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osukaa%2Fdogbane-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osukaa%2Fdogbane-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osukaa%2Fdogbane-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osukaa","download_url":"https://codeload.github.com/osukaa/dogbane-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osukaa%2Fdogbane-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271752125,"owners_count":24814750,"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","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-10-05T18:41:42.512Z","updated_at":"2025-08-23T14:36:28.575Z","avatar_url":"https://github.com/osukaa.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cipolla\n\nModule with pluggable themes to generate html from the API Blueprint JSON.\n\n## Usage\n\n```javascript\nvar cipolla = require('cipolla');\n\nvar generator = new cipolla(require('cipolla-test-theme'));\n\ngenerator.render(blueprintJSON, function (err, html) {\n\n});\n\ngenerator.renderToFile(blueprintJSON, 'path/to/file.html', function (err) {\n\n});\n```\n### Constructor Parameters\n\n* `theme` - theme plugin, needs the following interface\n    * `theme(options)` - theme constructor\n    * `render(blueprint, callback)` generates the html, the callback has the signature `function(err, html)`\n        * `err` any error during render\n        * `html` compiled html\n    * `renderToFile(blueprint, pathToFile, callback)` generates the html and saves it to a path, the callback has the signature `function(err)`\n        * `err` any error during render to file\n* `themeOptions` - optional options object to pass to the theme constructor\n\n## Theme interface\n\nWhen plugin a theme into `cipolla` you should implement this interface:\n\n* `Constructor(options)` constructor for the theme\n* `setOptions(options)` function that set the options passed to the theme from cipolla\n* `render(blueprint, callback)` function that renders templates and returns an html on callback, callback parameters\n    * `err` if there's any error present\n    * `html` render html from the template\n* `renderToFile(blueprint,pathToFile, callback)` function that renders template directly to a file, callback parameters\n    * `err` if there's any error\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosukaa%2Fdogbane-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosukaa%2Fdogbane-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosukaa%2Fdogbane-generator/lists"}