Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 0 additions & 43 deletions apache-maven/src/site/apt/index.apt.vm

This file was deleted.

39 changes: 39 additions & 0 deletions apache-maven/src/site/markdown/index.md.vm
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: ${project.name}
author:
- Hervé Boutemy
date: 2021-07-11
---

<!--
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}

${project.description}

References
----------

- `mvn` invocation can be customized through pre-invocation script calls, that can be disabled by setting `MAVEN_SKIP_RC` environment variable:

||system level|user level|
|:---|:---|:---|
|POSIX|`/etc/mavenrc` <br />`/usr/local/etc/mavenrc` (since 3.8.2)|`$HOME/.mavenrc`|
|Windows|`%PROGRAMDATA%\mavenrc.cmd` (since 4)|`%USERPROFILE%\mavenrc_pre.bat` <br />`%USERPROFILE%\mavenrc_pre.cmd` (since 3.3.1) <br />`%USERPROFILE%\mavenrc.cmd` (since 4)|
41 changes: 0 additions & 41 deletions api/maven-api-cli/src/site/apt/index.apt

This file was deleted.

38 changes: 38 additions & 0 deletions api/maven-api-cli/src/site/markdown/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Introduction
author:
- Hervé Boutemy
date: 2025-11-16
---

<!--
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.
-->

# Maven 4 API - CLI

This is the [API](./apidocs/org/apache/maven/api/cli/package-summary.html) for Maven's command-line interface and tools:

- [`mvn`](./apidocs/org/apache/maven/api/cli/mvn/package-summary.html), the Maven build tool,
- [`mvnenc`](./apidocs/org/apache/maven/api/cli/mvnenc/package-summary.html), the Maven Password Encryption tool,
- [`mvnsh`](./apidocs/org/apache/maven/api/cli/mvnsh/package-summary.html), the Maven Shell tool,
- [`mvnup`](./apidocs/org/apache/maven/api/cli/mvnup/package-summary.html), the Maven Upgrade tool.

This API also defines [Core Extensions model](./core-extensions.html) for `.mvn/extensions.xml`.

See also associated [implementation](../../impl/maven-cli/index.html).
33 changes: 0 additions & 33 deletions api/maven-api-metadata/src/site/apt/index.apt

This file was deleted.

33 changes: 33 additions & 0 deletions api/maven-api-metadata/src/site/markdown/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Introduction
author:
- Guillaume Nodet
date: 2024-04-04
---

<!--
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.
-->

# Maven 4 API - Repository Metadata Model

This is the immutable model for Repository Metadata in `org.apache.maven.api.metadata` package.

The following are generated from this model:

- [Java sources](./apidocs/index.html) with `Builder` inner classes for immutable instances creation.
36 changes: 0 additions & 36 deletions api/maven-api-model/src/site/apt/index.apt

This file was deleted.

37 changes: 37 additions & 0 deletions api/maven-api-model/src/site/markdown/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Introduction
author:
- Jason van Zyl
- Vincent Siveton
- Hervé Boutemy
date: 2011-06-12
---

<!--
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.
-->

# Maven 4 API - Immutable Maven Model

This is strictly the immutable model for Maven POM (Project Object Model), so really just plain objects in `org.apache.maven.api.model` package.

The following are generated from this model:

- [Java sources](./apidocs/index.html) with `Builder` inner classes for immutable instances creation.

See also corresponding [Maven classical POM model documentation](../../compat/maven-model/index.html).
33 changes: 0 additions & 33 deletions api/maven-api-plugin/src/site/apt/index.apt

This file was deleted.

33 changes: 33 additions & 0 deletions api/maven-api-plugin/src/site/markdown/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Introduction
author:
- Guillaume Nodet
date: 2023-11-15
---

<!--
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.
-->

# Maven 4 API - Plugin Descriptor Model

This is the immutable model for Maven Plugin Descriptor in `org.apache.maven.api.plugin.descriptor` package.

The following are generated from this model:

- [Java sources](./apidocs/index.html) with `Builder` inner classes for immutable instances creation.
Loading
Loading