https://github.com/kelnos/tut-maven-plugin

Maven plugin for Tut (https://tpolecat.github.io/tut/)
https://github.com/kelnos/tut-maven-plugin

documentation maven plugin scala tut

Last synced: about 1 month ago
JSON representation

Maven plugin for Tut (https://tpolecat.github.io/tut/)

• Host: GitHub
• URL: https://github.com/kelnos/tut-maven-plugin
• Owner: kelnos
• License: bsd-3-clause
• Created: 2019-08-23T09:53:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-27T21:45:56.000Z (10 months ago)
• Last Synced: 2024-05-02T01:14:36.365Z (8 months ago)
• Topics: documentation, maven, plugin, scala, tut
• Language: Scala
• Size: 46.9 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tut-maven-plugin

This is a Maven plugin that allows you to generate Scala documentation

snippets that contain code that is compiled to ensure the code is valid.

This is just a Maven plugin shell; the original project that does the

heavy lifting can be found [here](http://tpolecat.github.io/tut/).

Releases here will match the version of the corresponding Tut release.

If extra releases of this plugin are required for a given Tut version, a fourth version

component will be added to the plugin's version number.

## Usage

```xml

  

    

      org.spurint.maven.plugins

      tut-maven-plugin

      ${tut-maven-plugin.version}

      

        

          generate-documentation

          

            generate-documentation

          

          

            ${project.basedir}/docs-src

            ${project.basedir}/docs

            .*\\.(md|markdown|txt|htm|html)$

          

        

      

    

  

```

## Configuration

| Name | Default | Description |

|:-----|:--------|:------------|

| `sourceDirectory` | `${project.basedir}/docs-src` | The source root containing files to parse |

| `targetDirectory` | `${project.basedir}/docs` | The location to place generated documenation |

| `nameFiter` | `.*\\.(md\|markdown\|txt\|htm\|html)$` | A regular expression describing file names to be processed |

| `scalacOptions` | (taken from project) | A list of `` to pass to the Scala compiler |

| `pluginJars` | (taken from project) | A list of ``, paths to JAR files of compiler plugins |