Skip to content
Merged
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ build/
bin/
.jfrog/

node_modules/

.gradle
.idea/
*.iml
Expand Down
12 changes: 12 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,17 @@ Building and running tests:
./mvnw install
```

== Building the Documentation

The documentation is built using Antora and can be run using the Antora Maven plugin.

```
./mvnw antora -pl spring-shell-docs
```

After running the command, you can view the site for this branch in `spring-shell-docs/target/site`.



== License
Spring Shell is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
40 changes: 40 additions & 0 deletions spring-shell-docs/antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
antora:
extensions:
- require: '@springio/antora-extensions'
root_component_name: 'shell'
- require: '@springio/antora-extensions/asciinema-extension'
site:
title: Spring Shell
url: https://docs.spring.io/spring-shell/reference
robots: allow
git:
ensure_git_suffix: false
content:
sources:
- url: ..
# Refname matching:
# https://docs.antora.org/antora/latest/playbook/content-refname-matching/
branches: [ main,'({3..9}).+({0..9}).x', '!(3.0.x)', '!(3.1.x)' ]
tags: [ 'v({3..9}).+({0..9}).+({0..19})?(-{RC,M}+({0..9}))', '!(v3.0.+({0..9})?(-{RC,M}+({0..9})))', '!(v3.1.0-{RC,M}+({0..9}))', '!(v3.1.({0..19}))' ]
start_path: spring-shell-docs
asciidoc:
attributes:
page-stackoverflow-url: https://stackoverflow.com/tags/spring-shell
page-pagination: ''
hide-uri-scheme: '@'
tabs-sync-option: '@'
extensions:
- '@asciidoctor/tabs'
- '@springio/asciidoctor-extensions'
- '@springio/asciidoctor-extensions/javadoc-extension'
urls:
latest_version_segment_strategy: redirect:to
latest_version_segment: ''
redirect_facility: httpd
ui:
bundle:
url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip
snapshot: true
runtime:
log:
failure_level: warn
9 changes: 8 additions & 1 deletion spring-shell-docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
name: shell
version: 4.0.0-SNAPSHOT
version: true
title: Spring Shell
nav:
- modules/ROOT/nav.adoc
ext:
collector:
run:
command: mvnw process-resources -pl spring-shell-docs
local: true
scan:
dir: ./target/classes/antora-resources
10 changes: 10 additions & 0 deletions spring-shell-docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"dependencies": {
"antora": "3.2.0-alpha.9",
"@antora/atlas-extension": "1.0.0-alpha.5",
"@antora/collector-extension": "1.0.2",
"@asciidoctor/tabs": "1.0.0-beta.6",
"@springio/antora-extensions": "1.14.7",
"@springio/asciidoctor-extensions": "1.0.0-alpha.17"
}
}
33 changes: 15 additions & 18 deletions spring-shell-docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -45,33 +45,30 @@
</dependencies>

<build>
<resources>
<resource>
<directory>src/main/antora</directory>
<filtering>true</filtering>
<includes>
<include>antora-playbook.yml</include>
</includes>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.antora</groupId>
<artifactId>antora-maven-plugin</artifactId>
<version>${antora-maven-plugin.version}</version>
<version>1.0.0-alpha.5</version>
<extensions>true</extensions>
<configuration>
<nodeVersion>${nodejs.version}</nodeVersion>
<playbookFile>target/classes/antora-playbook.yml</playbookFile>
<environmentVariables>
<BUILD_REFNAME>HEAD</BUILD_REFNAME>
<BUILD_VERSION>${project.version}</BUILD_VERSION>
</environmentVariables>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>${maven-deploy-plugin.version}</version>
<configuration>
<skip>true</skip>
</configuration>
<groupId>io.spring.maven.antora</groupId>
<artifactId>antora-component-version-maven-plugin</artifactId>
<version>0.0.4</version>
<executions>
<execution>
<goals>
<goal>antora-component-version</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
Expand Down
27 changes: 0 additions & 27 deletions spring-shell-docs/src/main/antora/antora-playbook.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: ${antora-component.version}
prerelease: ${antora-component.prerelease}

asciidoc:
attributes:
page-stackoverflow-url: https://stackoverflow.com/tags/spring-shell
page-pagination: ''
hide-uri-scheme: '@'
tabs-sync-option: '@'
chomp: 'all'
attribute-missing: 'warn'
snippets: example$docs-src/test/java/org/springframework/shell/docs
project-version: ${project.parent.version}
sourcemap: true