diff --git a/pom.xml b/pom.xml index 0962b366..e3cf88ae 100644 --- a/pom.xml +++ b/pom.xml @@ -28,6 +28,7 @@ spring-shell-jcommander-adapter spring-shell-shell1-adapter spring-shell-starter + spring-shell-docs diff --git a/spring-shell-docs/pom.xml b/spring-shell-docs/pom.xml new file mode 100644 index 00000000..bc66561d --- /dev/null +++ b/spring-shell-docs/pom.xml @@ -0,0 +1,135 @@ + + 4.0.0 + + spring-shell-docs + Spring Shell Documentation + jar + + + org.springframework.shell + spring-shell-parent + 2.0.0.BUILD-SNAPSHOT + + + Spring Shell reference documentation + + 1.5.5 + 1.5.0-alpha.16 + 1.5.6 + 1.7.26 + + + + + org.asciidoctor + asciidoctor-maven-plugin + ${asciidoctor.maven.plugin.version} + + + org.asciidoctor + asciidoctorj-pdf + ${asciidoctorj.pdf.version} + + + + org.jruby + jruby-complete + ${jruby.version} + + + + org.asciidoctor + asciidoctorj + ${asciidoctorj.version} + + + + index.adoc + book + + true + warn + ${project.version} + ${project.artifactId} + + + + + generate-html5 + prepare-package + + process-asciidoc + + + html5 + + + shared-head + prettify + + + + + generate-pdf + prepare-package + + process-asciidoc + + + pdf + rouge + + + + + + + + + + maven-assembly-plugin + 3.1.0 + + + zip-docs + package + + single + + + + src/assembly/docs-zip.xml + + false + false + + + + + + org.codehaus.mojo + build-helper-maven-plugin + 1.9.1 + + + attach-zip + package + + attach-artifact + + + + + ${project.build.directory}/${project.artifactId}-${project.version}.zip + zip;zip.type=docs;zip.deployed=false + + + + + + + + + + diff --git a/spring-shell-docs/src/assembly/docs-zip.xml b/spring-shell-docs/src/assembly/docs-zip.xml new file mode 100644 index 00000000..811712e5 --- /dev/null +++ b/spring-shell-docs/src/assembly/docs-zip.xml @@ -0,0 +1,24 @@ + + docs + + zip + + + + ${project.build.directory}/generated-docs + reference/htmlsingle + + index.html + + + + ${project.build.directory}/generated-docs + reference/pdf + + index.pdf + + + + \ No newline at end of file diff --git a/spring-shell-docs/src/main/asciidoc/docinfo.html b/spring-shell-docs/src/main/asciidoc/docinfo.html new file mode 100644 index 00000000..f754ec0c --- /dev/null +++ b/spring-shell-docs/src/main/asciidoc/docinfo.html @@ -0,0 +1,74 @@ + + + + + + + + + \ No newline at end of file diff --git a/spring-shell-docs/src/main/asciidoc/extending-spring-shell.adoc b/spring-shell-docs/src/main/asciidoc/extending-spring-shell.adoc new file mode 100644 index 00000000..5be857e2 --- /dev/null +++ b/spring-shell-docs/src/main/asciidoc/extending-spring-shell.adoc @@ -0,0 +1,12 @@ +== Extending Spring Shell + +=== Support for Spring Shell 1 and JCommander + + +=== Discovering Methods that Can Act as Commands + +=== Resolving Parameter Values + +==== Supporting kbd:[TAB] Completion + + diff --git a/spring-shell-docs/src/main/asciidoc/index.adoc b/spring-shell-docs/src/main/asciidoc/index.adoc new file mode 100644 index 00000000..af58b390 --- /dev/null +++ b/spring-shell-docs/src/main/asciidoc/index.adoc @@ -0,0 +1,23 @@ += Spring Shell Reference Documentation +Eric Bottard; +:doctype: book +:hide-uri-scheme: +:icons: font +:experimental: // For kbd: macro + +Version {project-version} + +(C) 2017 Pivotal Software, Inc. + +_Copies of this document may be made for your own use and for distribution to +others, provided that you do not charge any fee for such copies and further +provided that each copy contains this Copyright Notice, whether distributed in +print or electronically._ + +// ====================================================================================== + +include::what-is-spring-shell.adoc[] + +include::using-spring-shell.adoc[] + +include::extending-spring-shell.adoc[] diff --git a/spring-shell-docs/src/main/asciidoc/using-spring-shell.adoc b/spring-shell-docs/src/main/asciidoc/using-spring-shell.adoc new file mode 100644 index 00000000..d27edd97 --- /dev/null +++ b/spring-shell-docs/src/main/asciidoc/using-spring-shell.adoc @@ -0,0 +1,47 @@ +== Using Spring Shell + +=== Getting started + +==== Let's Write a Simple Boot App + +==== Adding a Dependency on Spring Shell + +==== Your first command + +==== Let's Give It a Ride! + + + +=== Writing your own Commands +`@ShellComponent`, `@ShellMethod`, etc. + + +=== Invoking your commands +==== By Name _vs._ Positional Parameters +==== Quotes Handling +==== Interacting with the Shell +Line Continuation, TAB Completion, Search, etc. + + +=== Built-In Commands +* clear +* help +* exit +* stacktrace +* script + + + +=== Customizing the Shell + +==== Overriding or Disabling Built-In Commands + +==== ResultHandlers + +==== PromptProvider + +==== Customizing Command Line Options Behavior + +//==== Overriding the JLine Parser + +//=== Using Without Spring Boot diff --git a/spring-shell-docs/src/main/asciidoc/what-is-spring-shell.adoc b/spring-shell-docs/src/main/asciidoc/what-is-spring-shell.adoc new file mode 100644 index 00000000..516980f2 --- /dev/null +++ b/spring-shell-docs/src/main/asciidoc/what-is-spring-shell.adoc @@ -0,0 +1,2 @@ +== What is Spring Shell? +