{"id":17119164,"url":"https://github.com/regadas/sbt-socco","last_synced_at":"2025-04-13T04:41:01.870Z","repository":{"id":38040262,"uuid":"171327445","full_name":"regadas/sbt-socco","owner":"regadas","description":"sbt plugin for Socco. Socco is a Scala compiler plugin to generate documentation from Scala source files","archived":false,"fork":false,"pushed_at":"2025-03-18T00:27:38.000Z","size":230,"stargazers_count":5,"open_issues_count":18,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T21:38:00.077Z","etag":null,"topics":["sbt","sbt-plugin","scala"],"latest_commit_sha":null,"homepage":"http://gh.regadas.io/sbt-socco/Example.scala.html","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regadas.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":"2019-02-18T17:33:35.000Z","updated_at":"2024-12-10T20:44:02.000Z","dependencies_parsed_at":"2023-11-19T08:23:11.249Z","dependency_job_id":"acfa5ea2-1974-4856-9fbf-58ae1d8cb510","html_url":"https://github.com/regadas/sbt-socco","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/regadas%2Fsbt-socco","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regadas%2Fsbt-socco/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regadas%2Fsbt-socco/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regadas%2Fsbt-socco/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regadas","download_url":"https://codeload.github.com/regadas/sbt-socco/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248665782,"owners_count":21142122,"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":["sbt","sbt-plugin","scala"],"created_at":"2024-10-14T17:56:26.344Z","updated_at":"2025-04-13T04:41:01.851Z","avatar_url":"https://github.com/regadas.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sbt-socco\n[![Build Status](https://travis-ci.com/regadas/sbt-socco.svg?branch=master)](https://travis-ci.com/regadas/sbt-socco)\n[![Download](https://api.bintray.com/packages/regadas/sbt-plugins/sbt-socco/images/download.svg)](https://bintray.com/regadas/sbt-plugins/sbt-socco/_latestVersion)\n[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)\n\nThis is an sbt plugin for [socco-ng]\n\n\u003e Socco is a Scala compiler plugin to generate documentation from Scala source files.\n  It produces HTML documents that display your comments alongside your code. Comments are passed through Markdown, and the Scala code is syntax highlighted, typed and linked to the appropriate API Doc.\n  \n[socco-ng](https://github.com/socco-ng) is the updated form of [Socco] that was initially developed by our friends @ [Criteo]. \n\n## Usage\n\nStart by installing the sbt plugin in project/plugins.sbt. This plugin requires sbt 1.0.0+\n\n```scala\naddSbtPlugin(\"io.regadas\" % \"sbt-socco\" % \"0.1.0\")\n```\n\nThen in your build.sbt file, simply enable the `SbtSoccoPlugin` via an `enablePlugins` statement for your project.\n\n```scala\nenablePlugins(SbtSoccoPlugin)\n```\n\nYou can further customize the generated `html` documents through with the following settings:  \n\n* `soccoOut` - output directory for the generated `html` documents.\n* `soccoStyle` - path to a custom stylesheet.\n* `soccoHeader` - path to a custom `html` header.\n* `soccoFooter` - path to a custom `html` footer.\n* `soccoPackage` - List of packages and scaladoc url's. Needs to follow this \"$packageName:$scalaDocUrl\" pattern.\n* `soccoIndex` - Custom task that generates a `html` toc.\n* `soccoOnCompile` - If socco `html` documents should be generated at compile phase.\n\nIf you set `soccoOnCompile := false` to compile the examples you need to run:\n\n* `enableSocco` and then,\n* `compile`\n\n## How do I write examples?\n\nTo understand the supported syntax please check [socco](https://github.com/socco-ng) repo.\n\n## Examples\n\n* Simple scala [app](http://gh.regadas.io/sbt-socco/Example.scala.html).\n* Criteo socco [examples](https://github.com/criteo/socco#examples).\n\n## Thanks!\n\nThanks [Criteo] for providing [Socco]!\n\n[Criteo]: https://github.com/criteo\n[Socco]: https://github.com/criteo/socco\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregadas%2Fsbt-socco","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregadas%2Fsbt-socco","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregadas%2Fsbt-socco/lists"}