You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/07 09:30:32 UTC

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

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-indexer.git

commit b79702547c8ab224e2756fd5c1bf3fb856fef05e
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.
---
 indexer-cli/src/site/markdown/index.md.vm | 51 ++++++++++++++-----------------
 1 file changed, 23 insertions(+), 28 deletions(-)

diff --git a/indexer-cli/src/site/markdown/index.md.vm b/indexer-cli/src/site/markdown/index.md.vm
index 6b08ed2..9b7cf25 100644
--- a/indexer-cli/src/site/markdown/index.md.vm
+++ b/indexer-cli/src/site/markdown/index.md.vm
@@ -1,34 +1,29 @@
-~~ 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.
+<!--
+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
 
- -----
- ${project.name}
- -----
- Hervé Boutemy
- -----
- 2014-08-19
- -----
+http://www.apache.org/licenses/LICENSE-2.0
 
-${project.name}
+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.description}
+# ${project.name}
 
-* CLI Options Reference
+${project.description}
 
-  Use either <<unpack>> (<<<-u,--unpack>>>) or <<index>> (<<<-i,--index>>> and <<<-r,--repository>>>) options.
+CLI Options Reference
+---------------------
 
-%{snippet|file=${project.basedir}/target/test-classes/options.html|verbatim=false}
+Use either **unpack** (`-u,--unpack`) or **index** (`-i,--index` and `-r,--repository`) options.
+
+<!-- MACRO{snippet|file=${project.basedir}/target/test-classes/options.html|verbatim=false} -->