Skip to content

Commit 3c49965

Browse files
jminijmini
committed
Rework docs
1 parent 3e52234 commit 3c49965

29 files changed

+436
-145
lines changed

‎docs/.project‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>docs</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.pde.SchemaBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
</buildSpec>
14+
<natures>
15+
<nature>org.eclipse.pde.PluginNature</nature>
16+
</natures>
17+
</projectDescription>

‎docs/gh-pages_pages.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
index.html

‎docs/pom.xml‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
4+
5+
<groupId>com.wdev91.eclipse.copyright</groupId>
6+
<artifactId>docs</artifactId>
7+
<version>1.5.2</version>
8+
<packaging>pom</packaging>
9+
10+
<pluginRepositories>
11+
<pluginRepository>
12+
<id>bintray.jmini.maven</id>
13+
<url>http://dl.bintray.com/jmini/maven/</url>
14+
<releases>
15+
<enabled>true</enabled>
16+
</releases>
17+
<snapshots>
18+
<enabled>false</enabled>
19+
</snapshots>
20+
</pluginRepository>
21+
</pluginRepositories>
22+
23+
<properties>
24+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
25+
<asciidoctor.maven.plugin.version>1.5.3</asciidoctor.maven.plugin.version>
26+
<asciidoctorj.version>1.5.4</asciidoctorj.version>
27+
<asciidoctorj.gh-edit.version>3.0.0</asciidoctorj.gh-edit.version>
28+
<jruby.version>9.0.5.0</jruby.version>
29+
<github.global.server>github</github.global.server> <!-- this should match the sever id in your settings.xml -->
30+
<!-- The project URL on GitHub is : https://github.com/${github.repository.owner}/${github.repository.name} -->
31+
<github.repository.owner>jmini</github.repository.owner>
32+
<github.repository.name>Eclipse-Copyright-Generator</github.repository.name>
33+
<commit.message>Update the 'gh-pages' branch.</commit.message>
34+
</properties>
35+
36+
<build>
37+
<plugins>
38+
39+
<!-- Run AsciidoctorJ -->
40+
<plugin>
41+
<groupId>org.asciidoctor</groupId>
42+
<artifactId>asciidoctor-maven-plugin</artifactId>
43+
<version>${asciidoctor.maven.plugin.version}</version>
44+
<dependencies>
45+
<dependency>
46+
<groupId>org.jruby</groupId>
47+
<artifactId>jruby-complete</artifactId>
48+
<version>${jruby.version}</version>
49+
</dependency>
50+
<dependency>
51+
<groupId>org.asciidoctor</groupId>
52+
<artifactId>asciidoctorj</artifactId>
53+
<version>${asciidoctorj.version}</version>
54+
</dependency>
55+
<dependency>
56+
<groupId>com.bsiag.asciidoctorj</groupId>
57+
<artifactId>gh-edit</artifactId>
58+
<version>${asciidoctorj.gh-edit.version}</version>
59+
</dependency>
60+
</dependencies>
61+
<configuration>
62+
<sourceDirectory>src</sourceDirectory>
63+
<backend>html5</backend>
64+
<sourceHighlighter>coderay</sourceHighlighter>
65+
<attributes>
66+
<icons>font</icons>
67+
<sectanchors>true</sectanchors>
68+
<idprefix/>
69+
<idseparator>-</idseparator>
70+
<imagesdir/>
71+
<docinfo1>true</docinfo1>
72+
<toc>left</toc>
73+
<toclevels>3</toclevels>
74+
<sourcedir>${project.build.sourceDirectory}</sourcedir>
75+
<project-version>${project.version}</project-version>
76+
<last-released-version>${project.version}</last-released-version>
77+
</attributes>
78+
</configuration>
79+
<executions>
80+
<execution>
81+
<id>asciidoc-to-html</id>
82+
<phase>generate-resources</phase>
83+
<goals>
84+
<goal>process-asciidoc</goal>
85+
</goals>
86+
</execution>
87+
</executions>
88+
</plugin>
89+
90+
<!-- prepare index for github pages -->
91+
<plugin>
92+
<groupId>com.bsiag.htmltools</groupId>
93+
<artifactId>htmltools-maven-plugin</artifactId>
94+
<version>1.1.4</version>
95+
<executions>
96+
<execution>
97+
<phase>process-resources</phase>
98+
<goals>
99+
<goal>htmltools</goal>
100+
</goals>
101+
<configuration>
102+
<outputFolder>${project.build.directory}/gh-pages-docs</outputFolder>
103+
<pagesListFile>../eclipse_help/help-pages.txt</pagesListFile>
104+
<inputSources>
105+
<inputSource>
106+
<inputFolder>${project.build.directory}/generated-docs</inputFolder>
107+
<fixExternalLinks>false</fixExternalLinks>
108+
<fixXrefLinks>false</fixXrefLinks>
109+
<htmlOutput>
110+
<pagesListFile>${project.basedir}/gh-pages_pages.txt</pagesListFile>
111+
</htmlOutput>
112+
</inputSource>
113+
</inputSources>
114+
</configuration>
115+
</execution>
116+
</executions>
117+
</plugin>
118+
119+
<!-- Commit and push site to github pages, by default to gh-pages branch -->
120+
<!-- https://github.com/github/maven-plugins -->
121+
<plugin>
122+
<groupId>com.github.github</groupId>
123+
<artifactId>site-maven-plugin</artifactId>
124+
<version>0.12</version>
125+
<configuration>
126+
<message>${commit.message}</message>
127+
<outputDirectory>${project.build.directory}/gh-pages-docs</outputDirectory>
128+
<repositoryName>${github.repository.name}</repositoryName>
129+
<repositoryOwner>${github.repository.owner}</repositoryOwner>
130+
<dryRun>false</dryRun>
131+
<excludes>
132+
<exclude>**/*.jsp</exclude>
133+
<exclude>**/web.xml</exclude>
134+
</excludes>
135+
</configuration>
136+
<executions>
137+
<execution>
138+
<goals>
139+
<goal>site</goal>
140+
</goals>
141+
<phase>site</phase>
142+
</execution>
143+
</executions>
144+
</plugin>
145+
146+
<!-- Run mvn exec:exec to generate site and upload it with single step -->
147+
<plugin>
148+
<groupId>org.codehaus.mojo</groupId>
149+
<artifactId>exec-maven-plugin</artifactId>
150+
<version>1.2.1</version>
151+
<configuration>
152+
<executable>mvn</executable>
153+
<arguments>
154+
<argument>clean:clean</argument>
155+
<argument>asciidoctor:process-asciidoc</argument>
156+
<argument>site:site</argument>
157+
<argument>clean:clean</argument>
158+
</arguments>
159+
</configuration>
160+
</plugin>
161+
</plugins>
162+
</build>
163+
</project>

‎docs/src/config02.png‎

22.5 KB
Loading

‎docs/src/config03.png‎

5.29 KB
Loading

‎docs/src/config04.png‎

8.73 KB
Loading

‎docs/src/config05.png‎

22.8 KB
Loading

‎docs/src/guide04.png‎

3.02 KB
Loading

‎docs/src/guide05.png‎

5.45 KB
Loading

‎docs/src/guide06.png‎

1.35 KB
Loading

0 commit comments

Comments
 (0)