{"id":21391165,"url":"https://github.com/kelnos/tut-maven-plugin","last_synced_at":"2026-05-21T04:03:16.407Z","repository":{"id":43209151,"uuid":"203971907","full_name":"kelnos/tut-maven-plugin","owner":"kelnos","description":"Maven plugin for Tut (https://tpolecat.github.io/tut/)","archived":false,"fork":false,"pushed_at":"2024-06-24T17:18:08.000Z","size":48,"stargazers_count":0,"open_issues_count":14,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-23T01:10:05.140Z","etag":null,"topics":["documentation","maven","plugin","scala","tut"],"latest_commit_sha":null,"homepage":null,"language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kelnos.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":"2019-08-23T09:53:12.000Z","updated_at":"2020-12-27T08:18:29.000Z","dependencies_parsed_at":"2023-02-19T09:55:19.821Z","dependency_job_id":null,"html_url":"https://github.com/kelnos/tut-maven-plugin","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/kelnos%2Ftut-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelnos%2Ftut-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelnos%2Ftut-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelnos%2Ftut-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kelnos","download_url":"https://codeload.github.com/kelnos/tut-maven-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243872488,"owners_count":20361495,"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":["documentation","maven","plugin","scala","tut"],"created_at":"2024-11-22T13:24:10.943Z","updated_at":"2026-05-21T04:03:11.361Z","avatar_url":"https://github.com/kelnos.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tut-maven-plugin\n\nThis is a Maven plugin that allows you to generate Scala documentation\nsnippets that contain code that is compiled to ensure the code is valid.\nThis is just a Maven plugin shell; the original project that does the\nheavy lifting can be found [here](http://tpolecat.github.io/tut/).\n\nReleases here will match the version of the corresponding Tut release.\nIf extra releases of this plugin are required for a given Tut version, a fourth version\ncomponent will be added to the plugin's version number.\n\n## Usage\n\n```xml\n\u003cbuild\u003e\n  \u003cplugins\u003e\n    \u003cplugin\u003e\n      \u003cgroupId\u003eorg.spurint.maven.plugins\u003c/groupId\u003e\n      \u003cartifactId\u003etut-maven-plugin\u003c/artifactId\u003e\n      \u003cversion\u003e${tut-maven-plugin.version}\u003c/version\u003e\n      \u003cexecutions\u003e\n        \u003cexecution\u003e\n          \u003cid\u003egenerate-documentation\u003c/id\u003e\n          \u003cgoals\u003e\n            \u003cgoal\u003egenerate-documentation\u003c/goal\u003e\n          \u003c/goals\u003e\n          \u003cconfiguration\u003e\n            \u003csourceDirectory\u003e${project.basedir}/docs-src\u003c/sourceDirectory\u003e\n            \u003ctargetDirectory\u003e${project.basedir}/docs\u003c/targetDirectory\u003e\n            \u003cnameFilter\u003e.*\\\\.(md|markdown|txt|htm|html)$\u003c/nameFilter\u003e\n          \u003c/configuration\u003e\n        \u003c/execution\u003e\n      \u003c/executions\u003e\n    \u003c/plugin\u003e\n  \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\n## Configuration\n\n| Name | Default | Description |\n|:-----|:--------|:------------|\n| `sourceDirectory` | `${project.basedir}/docs-src` | The source root containing files to parse |\n| `targetDirectory` | `${project.basedir}/docs` | The location to place generated documenation |\n| `nameFiter` | `.*\\\\.(md\\|markdown\\|txt\\|htm\\|html)$` | A regular expression describing file names to be processed |\n| `scalacOptions` | (taken from project) | A list of `\u003cscalacOption\u003e` to pass to the Scala compiler |\n| `pluginJars` | (taken from project) | A list of `\u003cpluginJar\u003e`, paths to JAR files of compiler plugins |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelnos%2Ftut-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkelnos%2Ftut-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelnos%2Ftut-maven-plugin/lists"}