{"id":18256816,"url":"https://github.com/boundstate/sia","last_synced_at":"2025-04-04T18:30:38.349Z","repository":{"id":57359188,"uuid":"43479646","full_name":"boundstate/sia","owner":"boundstate","description":"doc generator for AngularJS modules","archived":false,"fork":false,"pushed_at":"2015-10-29T17:42:48.000Z","size":216,"stargazers_count":16,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-20T16:52:13.898Z","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/boundstate.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-10-01T05:15:22.000Z","updated_at":"2019-03-16T04:47:44.000Z","dependencies_parsed_at":"2022-09-06T21:41:26.424Z","dependency_job_id":null,"html_url":"https://github.com/boundstate/sia","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boundstate%2Fsia","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boundstate%2Fsia/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boundstate%2Fsia/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boundstate%2Fsia/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boundstate","download_url":"https://codeload.github.com/boundstate/sia/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247229088,"owners_count":20904979,"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-11-05T10:23:47.020Z","updated_at":"2025-04-04T18:30:38.039Z","avatar_url":"https://github.com/boundstate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sia - doc generator for AngularJS modules\n\n_sia_ is a documentation generator built on [dgeni] that uses [Angular Material] and is heavily inspired by it's docs.\n\n## Usage\n\n```sh\nnpm install sia --save-dev\n```\n\n```js\n// gulpfile.js\nvar gulp = require('gulp');\nvar pkg = require('./package.json');\n\nrequire('sia')(gulp, {\n  basePath: __dirname,\n  moduleTitle: 'My Module',\n  modulePrefix: 'myModule',\n  ngVersion: '1.4.6',\n  moduleJs: ['../my-module.js'],\n  moduleCss: ['../my-module.css'],\n  repositoryUrl: pkg.repository \u0026\u0026 pkg.repository.url.replace(/^git/, 'https').replace(/(\\.git)?\\/?$/,'')\n});\n```\n\nGenerate docs:\n\n```sh\ngulp docs\n```\n\nServe docs with local webserver:\n\n```sh\ngulp docs:serve\n```\n\n### Options\n\n- **basePath** `string` - Base path where `src` and `docs` folders are located.\n- **moduleTitle** `string` - Title displayed in docs.\n- **modulePrefix** `string` - Module prefix used when determining module ids from folder structure.\n- **ngVersion** `string`  - AngularJS version to load.\n  (*angular*, *angular-animate*, *angular-route*, *angular-aria*, and *angular-messages* are automatically loaded)\n- **moduleJs** `Array` - JavaScript files to load.\n- **moduleCss** `Array` - CSS files to load.\n- repositoryUrl `string` - Repository base URL.\n- debug `boolean` - Debug mode. Default `false`.\n\n### Content\n\nMarkdown files in `{basePath}/docs` that have `@ngdoc content` are included in the generated docs. Create the\ndocumentation homepage at `docs/index.md`:\n\n```html\n\u003c!-- docs/index.md --\u003e\n@ngdoc content\n@name Introduction\n@description\n...\n```\n\nTo display a file in the docs sidenav use `@area nav`.\n\n### Components\n\nComponents in `{basePath}/src}` that have `@ngdoc service`, `@ngdoc directive`, or `@ngdoc filter` are included in the\ndocs if they belong to a documented module.\n\nFor example:\n\n```js\n/**\n * @ngdoc module\n * @name myApp.components.accordion\n */\n \n/**\n * @ngdoc directive\n * @name accordion\n * @module myApp.components.accordion\n * @description\n * Accordion\n */\n ```\n\n[dgeni]: https://github.com/angular/dgeni\n[Angular Material]: https://material.angularjs.org/","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboundstate%2Fsia","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboundstate%2Fsia","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboundstate%2Fsia/lists"}