(maven-jarsigner) 02/02: Port the index page from APT to Markdown

[sl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-jarsigner.git

commit fcd4fa751c59a1e4a77f62d66ac12a56607d2ceb
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 19:44:56 2026 +0200

    Port the index page from APT to Markdown
    
    Converted with doxia-converter and then cleaned up by hand:
    
    - <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
      becomes [text](url)
    - the ASF license header becomes a single block HTML comment
    - the page keeps a Velocity reference, so it stays a .vm. Velocity reads ## as
      a line comment and would silently swallow every ATX heading below level one,
      so subsections use setext underlines and anything deeper is wrapped in
      #[[ ... ]]#
    
    Verified by building the site before and after: the rendered page is
    unchanged apart from <b>/<i> becoming <strong>/<em> and quotes in prose
    picking up the Markdown module's typographic substitution.
---
 src/site/markdown/index.md.vm | 97 ++++++++++++++++++++-----------------------
 1 file changed, 44 insertions(+), 53 deletions(-)

diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
index 7dd3d04..05010ae 100644
--- a/src/site/markdown/index.md.vm
+++ b/src/site/markdown/index.md.vm
@@ -1,50 +1,43 @@
- ------
- Overview
- ------
- Olivier Lamy
- ------
- 2013-07-24
- ------
-
- ~~ 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/doxia/references/apt-format.html
-
-${project.name}
-
-  This component provides some utilities to sign/verify jars/files in your Mojos.
-
-* Dependency declaration
-
-+---------
+<!--
+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.
+-->
+
+# ${project.name}
+
+This component provides some utilities to sign/verify jars/files in your Mojos.
+
+Dependency declaration
+----------------------
+
+```unknown
     <dependency>
       <groupId>org.apache.maven.shared</groupId>
       <artifactId>maven-jarsigner</artifactId>
       <version>${project.version}</version>
     </dependency>
-+---------
+```
 
-* Sign a jar
+Sign a jar
+----------
 
-  You must construct a JarSignerSignRequest. See {{{./apidocs/org/apache/maven/shared/jarsigner/JarSignerSignRequest.html}javadoc}} for more available options.
+You must construct a JarSignerSignRequest. See [javadoc](./apidocs/org/apache/maven/shared/jarsigner/JarSignerSignRequest.html) for more available options.
 
-+---------
+```unknown
 
     JarSignerSignRequest request = new JarSignerSignRequest();
     request.setArchive( target );
@@ -54,41 +47,39 @@ ${project.name}
     request.setKeypass( "key-passwd" );
     request.setStorepass( "changeit" );
     request.setSignedjar( new File( "target/ssimple.jar" ) );
+```
 
-+---------
-
-  Now you can use the component to sign your jar:
+Now you can use the component to sign your jar:
 
-+---------
+```unknown
 
     JavaToolResult result = jarSigner.execute( jarSignerRequest );
     // control the execution result
     result.getExitCode()
     // get exception
     result.getExecutionException()
+```
 
-+---------
+Verify a signed jar
+-------------------
 
-* Verify a signed jar
+You must construct a JarSignerVerifyRequest. See [javadoc](./apidocs/org/apache/maven/shared/jarsigner/JarSignerVerifyRequest.html) for more available options.
 
-  You must construct a JarSignerVerifyRequest. See {{{./apidocs/org/apache/maven/shared/jarsigner/JarSignerVerifyRequest.html}javadoc}} for more available options.
-
-+----------
+```unknown
     JarSignerVerifyRequest request = new JarSignerVerifyRequest();
     request.setCerts( true );
     request.setKeystore( "src/test/keystore" );
     request.setVerbose( true );
     request.setAlias( "foo_alias" );
     request.setArchive( new File( "target/ssimple.jar" ) );
-+----------
+```
 
-  Now you can use the component to verify your signed jar:
+Now you can use the component to verify your signed jar:
 
-+----------
+```unknown
     JavaToolResult result = jarSigner.execute( request );
     // control the execution result
     result.getExitCode()
     // get exception
     result.getExecutionException()
-+----------
-
+```