Skip to content

Commit e8eb008

Browse files
author
synapticloop
committed
added in inline code for dependencies
1 parent c742752 commit e8eb008

File tree

3 files changed

+40
-38
lines changed

3 files changed

+40
-38
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a name="documentr_top"></a>[![Build Status](https://travis-ci.org/synapticloop/documentr.svg?branch=master)](https://travis-ci.org/synapticloop/documentr) [![Download](https://api.bintray.com/packages/synapticloop/maven/documentr/images/download.svg)](https://bintray.com/synapticloop/maven/documentr/_latestVersion) [![GitHub Release](https://img.shields.io/github/release/synapticloop/documentr.svg)](https://github.com/synapticloop/documentr/releases) [![Gradle Plugin Release](https://img.shields.io/badge/gradle%20plugin-2.7.1-blue.svg)](https://plugins.gradle.org/plugin/synapticloop.documentr)
1+
<a name="documentr_top"></a>[![Build Status](https://travis-ci.org/synapticloop/documentr.svg?branch=master)](https://travis-ci.org/synapticloop/documentr) [![Download](https://api.bintray.com/packages/synapticloop/maven/documentr/images/download.svg)](https://bintray.com/synapticloop/maven/documentr/_latestVersion) [![GitHub Release](https://img.shields.io/github/release/synapticloop/documentr.svg)](https://github.com/synapticloop/documentr/releases) [![Gradle Plugin Release](https://img.shields.io/badge/gradle%20plugin-2.7.2-blue.svg)](https://plugins.gradle.org/plugin/synapticloop.documentr)
22

33
> **This project requires JVM version of at least 1.7**
44
@@ -323,7 +323,7 @@ buildscript {
323323
}
324324
}
325325
dependencies {
326-
classpath "gradle.plugin.synapticloop:documentr:2.7.1"
326+
classpath "gradle.plugin.synapticloop:documentr:2.7.2"
327327
}
328328
}
329329
@@ -338,7 +338,7 @@ apply plugin: "synapticloop.documentr"
338338

339339
```
340340
plugins {
341-
id 'synapticloop.documentr' version '2.7.1'
341+
id 'synapticloop.documentr' version '2.7.2'
342342
}
343343
```
344344

@@ -375,7 +375,7 @@ simply run
375375

376376

377377
```
378-
java -jar documentr-2.7.1-all.jar
378+
java -jar documentr-2.7.2-all.jar
379379
```
380380

381381

@@ -391,7 +391,7 @@ Running:
391391

392392

393393
```
394-
java -jar documentr-2.7.1-all.jar --help
394+
java -jar documentr-2.7.2-all.jar --help
395395
```
396396

397397

@@ -824,9 +824,9 @@ repositories {
824824

825825
```
826826
dependencies {
827-
runtime(group: 'synapticloop', name: 'documentr', version: '2.7.1', ext: 'jar')
827+
runtime(group: 'synapticloop', name: 'documentr', version: '2.7.2', ext: 'jar')
828828
829-
compile(group: 'synapticloop', name: 'documentr', version: '2.7.1', ext: 'jar')
829+
compile(group: 'synapticloop', name: 'documentr', version: '2.7.2', ext: 'jar')
830830
}
831831
```
832832

@@ -838,9 +838,9 @@ or, more simply for versions of gradle greater than 2.1
838838

839839
```
840840
dependencies {
841-
runtime 'synapticloop:documentr:2.7.1'
841+
runtime 'synapticloop:documentr:2.7.2'
842842
843-
compile 'synapticloop:documentr:2.7.1'
843+
compile 'synapticloop:documentr:2.7.2'
844844
}
845845
```
846846

@@ -858,7 +858,7 @@ dependencies {
858858
<dependency>
859859
<groupId>synapticloop</groupId>
860860
<artifactId>documentr</artifactId>
861-
<version>2.7.1</version>
861+
<version>2.7.2</version>
862862
<type>jar</type>
863863
</dependency>
864864
```
@@ -878,26 +878,26 @@ You will also need to download the following dependencies:
878878

879879
### compile dependencies
880880

881-
- synapticloop:simpleusage:1.1.2: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/simpleusage/1.1.2/view#files/synapticloop/simpleusage/1.1.2) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|simpleusage|1.1.2|jar))
882-
- synapticloop:simplelogger:1.1.0: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/simplelogger/1.1.0/view#files/synapticloop/simplelogger/1.1.0) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|simplelogger|1.1.0|jar))
883-
- synapticloop:templar:1.3.0: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/templar/1.3.0/view#files/synapticloop/templar/1.3.0) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|templar|1.3.0|jar))
884-
- commons-io:commons-io:2.4: (It may be available on one of: [bintray](https://bintray.com/commons-io/maven/commons-io/2.4/view#files/commons-io/commons-io/2.4) [mvn central](http://search.maven.org/#artifactdetails|commons-io|commons-io|2.4|jar))
885-
- org.json:json:20160212: (It may be available on one of: [bintray](https://bintray.com/org.json/maven/json/20160212/view#files/org.json/json/20160212) [mvn central](http://search.maven.org/#artifactdetails|org.json|json|20160212|jar))
886-
- commons-cli:commons-cli:1.3.1: (It may be available on one of: [bintray](https://bintray.com/commons-cli/maven/commons-cli/1.3.1/view#files/commons-cli/commons-cli/1.3.1) [mvn central](http://search.maven.org/#artifactdetails|commons-cli|commons-cli|1.3.1|jar))
887-
- nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.0: (It may be available on one of: [bintray](https://bintray.com/nl.jworks.markdown_to_asciidoc/maven/markdown_to_asciidoc/1.0/view#files/nl.jworks.markdown_to_asciidoc/markdown_to_asciidoc/1.0) [mvn central](http://search.maven.org/#artifactdetails|nl.jworks.markdown_to_asciidoc|markdown_to_asciidoc|1.0|jar))
888-
- org.pegdown:pegdown:1.6.0: (It may be available on one of: [bintray](https://bintray.com/org.pegdown/maven/pegdown/1.6.0/view#files/org.pegdown/pegdown/1.6.0) [mvn central](http://search.maven.org/#artifactdetails|org.pegdown|pegdown|1.6.0|jar))
881+
- `synapticloop:simpleusage:1.1.2`: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/simpleusage/1.1.2/view#files/synapticloop/simpleusage/1.1.2) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|simpleusage|1.1.2|jar))
882+
- `synapticloop:simplelogger:1.1.1`: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/simplelogger/1.1.1/view#files/synapticloop/simplelogger/1.1.1) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|simplelogger|1.1.1|jar))
883+
- `synapticloop:templar:1.3.0`: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/templar/1.3.0/view#files/synapticloop/templar/1.3.0) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|templar|1.3.0|jar))
884+
- `commons-io:commons-io:2.5`: (It may be available on one of: [bintray](https://bintray.com/commons-io/maven/commons-io/2.5/view#files/commons-io/commons-io/2.5) [mvn central](http://search.maven.org/#artifactdetails|commons-io|commons-io|2.5|jar))
885+
- `org.json:json:20160810`: (It may be available on one of: [bintray](https://bintray.com/org.json/maven/json/20160810/view#files/org.json/json/20160810) [mvn central](http://search.maven.org/#artifactdetails|org.json|json|20160810|jar))
886+
- `commons-cli:commons-cli:1.3.1`: (It may be available on one of: [bintray](https://bintray.com/commons-cli/maven/commons-cli/1.3.1/view#files/commons-cli/commons-cli/1.3.1) [mvn central](http://search.maven.org/#artifactdetails|commons-cli|commons-cli|1.3.1|jar))
887+
- `nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.0`: (It may be available on one of: [bintray](https://bintray.com/nl.jworks.markdown_to_asciidoc/maven/markdown_to_asciidoc/1.0/view#files/nl.jworks.markdown_to_asciidoc/markdown_to_asciidoc/1.0) [mvn central](http://search.maven.org/#artifactdetails|nl.jworks.markdown_to_asciidoc|markdown_to_asciidoc|1.0|jar))
888+
- `org.pegdown:pegdown:1.6.0`: (It may be available on one of: [bintray](https://bintray.com/org.pegdown/maven/pegdown/1.6.0/view#files/org.pegdown/pegdown/1.6.0) [mvn central](http://search.maven.org/#artifactdetails|org.pegdown|pegdown|1.6.0|jar))
889889

890890

891891
### runtime dependencies
892892

893-
- synapticloop:simpleusage:1.1.2: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/simpleusage/1.1.2/view#files/synapticloop/simpleusage/1.1.2) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|simpleusage|1.1.2|jar))
894-
- synapticloop:simplelogger:1.1.0: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/simplelogger/1.1.0/view#files/synapticloop/simplelogger/1.1.0) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|simplelogger|1.1.0|jar))
895-
- synapticloop:templar:1.3.0: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/templar/1.3.0/view#files/synapticloop/templar/1.3.0) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|templar|1.3.0|jar))
896-
- commons-io:commons-io:2.4: (It may be available on one of: [bintray](https://bintray.com/commons-io/maven/commons-io/2.4/view#files/commons-io/commons-io/2.4) [mvn central](http://search.maven.org/#artifactdetails|commons-io|commons-io|2.4|jar))
897-
- org.json:json:20160212: (It may be available on one of: [bintray](https://bintray.com/org.json/maven/json/20160212/view#files/org.json/json/20160212) [mvn central](http://search.maven.org/#artifactdetails|org.json|json|20160212|jar))
898-
- commons-cli:commons-cli:1.3.1: (It may be available on one of: [bintray](https://bintray.com/commons-cli/maven/commons-cli/1.3.1/view#files/commons-cli/commons-cli/1.3.1) [mvn central](http://search.maven.org/#artifactdetails|commons-cli|commons-cli|1.3.1|jar))
899-
- nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.0: (It may be available on one of: [bintray](https://bintray.com/nl.jworks.markdown_to_asciidoc/maven/markdown_to_asciidoc/1.0/view#files/nl.jworks.markdown_to_asciidoc/markdown_to_asciidoc/1.0) [mvn central](http://search.maven.org/#artifactdetails|nl.jworks.markdown_to_asciidoc|markdown_to_asciidoc|1.0|jar))
900-
- org.pegdown:pegdown:1.6.0: (It may be available on one of: [bintray](https://bintray.com/org.pegdown/maven/pegdown/1.6.0/view#files/org.pegdown/pegdown/1.6.0) [mvn central](http://search.maven.org/#artifactdetails|org.pegdown|pegdown|1.6.0|jar))
893+
- `synapticloop:simpleusage:1.1.2`: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/simpleusage/1.1.2/view#files/synapticloop/simpleusage/1.1.2) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|simpleusage|1.1.2|jar))
894+
- `synapticloop:simplelogger:1.1.1`: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/simplelogger/1.1.1/view#files/synapticloop/simplelogger/1.1.1) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|simplelogger|1.1.1|jar))
895+
- `synapticloop:templar:1.3.0`: (It may be available on one of: [bintray](https://bintray.com/synapticloop/maven/templar/1.3.0/view#files/synapticloop/templar/1.3.0) [mvn central](http://search.maven.org/#artifactdetails|synapticloop|templar|1.3.0|jar))
896+
- `commons-io:commons-io:2.5`: (It may be available on one of: [bintray](https://bintray.com/commons-io/maven/commons-io/2.5/view#files/commons-io/commons-io/2.5) [mvn central](http://search.maven.org/#artifactdetails|commons-io|commons-io|2.5|jar))
897+
- `org.json:json:20160810`: (It may be available on one of: [bintray](https://bintray.com/org.json/maven/json/20160810/view#files/org.json/json/20160810) [mvn central](http://search.maven.org/#artifactdetails|org.json|json|20160810|jar))
898+
- `commons-cli:commons-cli:1.3.1`: (It may be available on one of: [bintray](https://bintray.com/commons-cli/maven/commons-cli/1.3.1/view#files/commons-cli/commons-cli/1.3.1) [mvn central](http://search.maven.org/#artifactdetails|commons-cli|commons-cli|1.3.1|jar))
899+
- `nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.0`: (It may be available on one of: [bintray](https://bintray.com/nl.jworks.markdown_to_asciidoc/maven/markdown_to_asciidoc/1.0/view#files/nl.jworks.markdown_to_asciidoc/markdown_to_asciidoc/1.0) [mvn central](http://search.maven.org/#artifactdetails|nl.jworks.markdown_to_asciidoc|markdown_to_asciidoc|1.0|jar))
900+
- `org.pegdown:pegdown:1.6.0`: (It may be available on one of: [bintray](https://bintray.com/org.pegdown/maven/pegdown/1.6.0/view#files/org.pegdown/pegdown/1.6.0) [mvn central](http://search.maven.org/#artifactdetails|org.pegdown|pegdown|1.6.0|jar))
901901

902902
**NOTE:** You may need to download any dependencies of the above dependencies in turn (i.e. the transitive dependencies)
903903

@@ -923,7 +923,7 @@ This should appear in the artefact repository along with the compiled code, as a
923923

924924
For example:
925925

926-
`documentr-2.7.1.jar -> documentr-2.7.1-all.jar`
926+
`documentr-2.7.2.jar -> documentr-2.7.2-all.jar`
927927

928928

929929

build.gradle

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ buildscript {
1313
}
1414

1515
dependencies {
16-
classpath 'synapticloop:documentr:2.7.1'
16+
classpath 'synapticloop:documentr:2.7.2'
1717
}
1818
}
1919

@@ -23,7 +23,8 @@ plugins {
2323
id 'eclipse'
2424
id 'maven'
2525
id 'maven-publish'
26-
id 'com.gradle.plugin-publish' version '0.9.3'
26+
27+
id 'com.gradle.plugin-publish' version '0.9.7'
2728
id 'co.riiid.gradle' version '0.4.2'
2829
id 'com.jfrog.bintray' version '1.6'
2930
id 'synapticloop.copyrightr' version '1.0.1'
@@ -37,7 +38,7 @@ group = 'synapticloop'
3738
archivesBaseName = 'documentr'
3839
description = """documentation (README) generator for projects in both markdown and asciidoc - this utilises the templar templating language - including generation of table of contents"""
3940

40-
version = '2.7.1'
41+
version = '2.7.2'
4142

4243
sourceCompatibility = 1.7
4344
targetCompatibility = 1.7
@@ -56,20 +57,20 @@ configurations {
5657
// now for all of the dependencies
5758
dependencies {
5859
runtime 'synapticloop:simpleusage:1.1.2'
59-
runtime 'synapticloop:simplelogger:1.1.0'
60+
runtime 'synapticloop:simplelogger:1.1.1'
6061
runtime 'synapticloop:templar:1.3.0'
61-
runtime 'commons-io:commons-io:2.4'
62-
runtime 'org.json:json:20160212'
62+
runtime 'commons-io:commons-io:2.5'
63+
runtime 'org.json:json:20160810'
6364
runtime 'commons-cli:commons-cli:1.3.1'
6465
runtime 'nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.0'
6566
runtime 'org.pegdown:pegdown:1.6.0'
6667

6768
compile gradleApi()
6869
compile 'synapticloop:simpleusage:1.1.2'
69-
compile 'synapticloop:simplelogger:1.1.0'
70+
compile 'synapticloop:simplelogger:1.1.1'
7071
compile 'synapticloop:templar:1.3.0'
71-
compile 'commons-io:commons-io:2.4'
72-
compile 'org.json:json:20160212'
72+
compile 'commons-io:commons-io:2.5'
73+
compile 'org.json:json:20160810'
7374
compile 'commons-cli:commons-cli:1.3.1'
7475
compile 'nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.0'
7576
compile 'org.pegdown:pegdown:1.6.0'
@@ -79,7 +80,8 @@ dependencies {
7980
configurations.all {
8081
resolutionStrategy {
8182
failOnVersionConflict()
82-
force 'org.pegdown:pegdown:1.6.0'
83+
force 'org.pegdown:pegdown:1.6.0',
84+
'org.json:json:20160810'
8385
}
8486
}
8587

src/main/resources/dependencies.md.templar

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
{endif}
5858

5959
{if !fn:=[dependency.name, 'unspecified']}
60-
{\ }- {dependency.group}:{dependency.name}:{dependency.version}: (It may be available on one of:
60+
{\ }- `{dependency.group}:{dependency.name}:{dependency.version}`: (It may be available on one of:
6161
[bintray](https://bintray.com/{dependency.group}/maven/{dependency.name}/{dependency.version}/view#files/{dependency.group}/{dependency.name}/{dependency.version})
6262
[mvn central](http://search.maven.org/#artifactdetails|{dependency.group}|{dependency.name}|{dependency.version}|jar)){\n}
6363
{endif}

0 commit comments

Comments
 (0)