maven-archetype-plugin-site/src/site/apt/index.apt.vm

 ------
 ${project.name}
 ------
 Hervé Boutemy
 ------
 2010-04-26
 ------

~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements.  See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership.  The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License.  You may obtain a copy of the License at
~~
~~   http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied.  See the License for the
~~ specific language governing permissions and limitations
~~ under the License.

~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html

${project.name}

 <<<${project.artifactId}>>> is an archetype which generates a sample Maven plugin's site:

+----+

project
|-- pom.xml
`-- src
    `-- site
        |-- apt
        |   |-- examples
        |   |   `-- example.apt
        |   |-- index.apt
        |   `-- usage.apt
        |-- markdown
        |   |-- markdown.md
        |   `-- markdown-velocity.md.vm
        `-- site.xml

+----+

 This archetype can be layered upon an existing Maven project.

* Usage

 To generate a new project or update an existing project from this archetype, type:

+----+

mvn archetype:generate -DarchetypeGroupId=${project.groupId} -DarchetypeArtifactId=${project.artifactId} -DarchetypeVersion=${project.version}

+----+