{"id":18342564,"url":"https://github.com/bmuschko/gradle-java2html-plugin","last_synced_at":"2025-04-06T07:32:13.240Z","repository":{"id":2180520,"uuid":"3127789","full_name":"bmuschko/gradle-java2html-plugin","owner":"bmuschko","description":"Gradle plugin for turning source code into HTML, RTF, TeX and XHTML using Java2HTML ","archived":false,"fork":false,"pushed_at":"2019-03-05T22:04:08.000Z","size":259,"stargazers_count":9,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-21T18:52:24.630Z","etag":null,"topics":["documentation","gradle-plugin"],"latest_commit_sha":null,"homepage":"","language":"Groovy","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/bmuschko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-01-08T01:15:46.000Z","updated_at":"2024-12-03T16:12:29.000Z","dependencies_parsed_at":"2022-08-19T21:20:32.403Z","dependency_job_id":null,"html_url":"https://github.com/bmuschko/gradle-java2html-plugin","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Fgradle-java2html-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Fgradle-java2html-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Fgradle-java2html-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmuschko%2Fgradle-java2html-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bmuschko","download_url":"https://codeload.github.com/bmuschko/gradle-java2html-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247450389,"owners_count":20940910,"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","gradle-plugin"],"created_at":"2024-11-05T20:31:34.721Z","updated_at":"2025-04-06T07:32:12.764Z","avatar_url":"https://github.com/bmuschko.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gradle Java2HTML plugin [![Build Status](https://travis-ci.org/bmuschko/gradle-java2html-plugin.svg?branch=master)](https://travis-ci.org/bmuschko/gradle-java2html-plugin)\n\n![Java2HTML Logo](http://www.java2html.de/java2html_logo_big.gif)\n\nThe plugin uses [Java2Html Ant task](http://www.java2html.de/docs/anttask/index.html) to convert Java (and other) source\ncode (complete files or snippets) to HTML, RTF, TeX and XHTML with syntax highlighting. The task is only available to projects\nthat apply the [Java](http://www.gradle.org/docs/current/userguide/java_plugin.html) or [Groovy](http://www.gradle.org/docs/current/userguide/groovy_plugin.html)\nplugin.\n\n## Usage\n\nTo use the Java2HTML plugin, include in your build script:\n\n    apply plugin: 'com.bmuschko.java2html'\n\nThe plugin JAR needs to be defined in the classpath of your build script. It is directly available on\n[Bintray](https://bintray.com/bmuschko/gradle-plugins/com.bmuschko%3Agradle-java2html-plugin).\nAlternatively, you can download it from GitHub and deploy it to your local repository. The following code snippet shows an\nexample on how to retrieve it from Bintray:\n\n    buildscript {\n        repositories {\n            jcenter()\n        }\n\n        dependencies {\n            classpath 'com.bmuschko:gradle-java2html-plugin:2.0.1'\n        }\n    }\n\nTo define the Java2HTML dependency please use the `java2html` configuration name in your `dependencies` closure.\n\n    dependencies {\n        java2html 'de.java2html:java2html:5.0'\n    }\n\n## Tasks\n\nThe Java2HTML plugin defines the following tasks:\n\n* `java2htmlConvertCode`: Converts source code files to Java2HTML documentation.\n* `java2htmlGenerateOverview`: Generates HTML overview files for Java2HTML documentation.\n\n## Extension properties\n\nThe Java2HTML plugin defines the following convention properties in the `java2html` closure. This closure itself contains\ntwo closures for each of the tasks: `conversion` and `overview`.\n\nIn the closure `conversion` you can define property values for converting the source code:\n\n* `srcDirs`: Source directories to look for source code files for conversion (defaults to `file('src/main/java')` for a Java\nproject and to `files('src/main/java', 'src/main/groovy')` for a Groovy project).\n* `destDir`: Destination folder for output of the converted files (defaults to `file('build/docs/java2html')`).\n* `includes`: File mask for input files (defaults to `**/*.java,**/*.groovy`).\n* `outputFormat`: File format for conversion output (defaults to `html`). Valid values are `html`, `xhtml11`, `xhtml`, `tex`, `rtf` and `xml`.\n* `tabs`: Width in spaces for a tab character (defaults to 2).\n* `style`: Sets the table name for the output style (defaults to `eclipse`). Valid values are `eclipse`, `kawa` and `monochrome`.\n* `showLineNumbers`: Show line numbers in conversion output (defaults to `true`).\n* `showFileName`: Show the file name in conversion output (defaults to `false`).\n* `showDefaultTitle`: Sets the title of generated html pages (if any) to the relative name of the source file, e.g. `de/java2html/Java2Html.java` (defaults to empty `false`).\n* `showTableBorder`: Show a border around the conversion output (defaults to `false`).\n* `includeDocumentHeader`: Add a document header at the beginning of the output file (defaults to `true`).\n* `includeDocumentFooter`: Add a document footer at the end of the output file (defaults to `true`).\n* `addLineAnchors`: Add html-anchors to each line for html output (defaults to `false`).\n* `lineAnchorPrefix`: String that will be added as prefix for the line anchors for html output (defaults to `''`).\n* `horizontalAlignment`: Horizontal alignment of the output (defaults to `left`). Valid values are `left`, `center` and `right`.\n* `useShortFileName`: Use short (`ClassName.html`) or long (`ClassName.java.html`) filenames for output (defaults to `false`).\n* `overwrite`: Overwrite existing files even if the destination files are newer (defaults to `false`).\n\nIn the closure `overview` you can define property values for generating the HTML overview files:\n\n* `srcDirs`: Source directories to look for generated files by Java2HTML (defaults to `file('build/docs/java2html')` of all modules\nin project).\n* `destDir`: Destination folder for HTML overview files (defaults to `file('build/docs/java2html')`).\n* `pattern`: Java2HTML file pattern to be included in HTML overview (defaults to `**/*.html`).\n* `windowTitle`: Window title in overview (defaults to project name).\n* `docTitle`: Document title in overview (defaults to project name).\n* `docDescription`: Document description in overview.\n* `icon`: Icon file to be use in overview.\n* `stylesheet`: CSS stylesheet file to be use in overview (defaults to JavaDoc stylesheet).\n\n### Example\n\n    java2html {\n        conversion {\n            tabs = 4\n            style = 'eclipse'\n            showFileName = true\n            useShortFileName = true\n            override = true\n            showDefaultTitle = true\n        }\n\n        overview {\n            docDescription = 'Gradle plugin for turning source code into HTML, RTF, TeX and XHTML using Java2HTML.'\n        }\n    }","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmuschko%2Fgradle-java2html-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbmuschko%2Fgradle-java2html-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmuschko%2Fgradle-java2html-plugin/lists"}