Skip to content

Commit 3ec751a

Browse files
author
sebastian
committed
#1: Added HTML rendering via Maven plug-in.
Task-Url: http://github.com/itsallcode/openfasttrace-architecture-template/issues/1
1 parent 6e95da8 commit 3ec751a

File tree

10 files changed

+163
-58
lines changed

10 files changed

+163
-58
lines changed

‎.classpath‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,10 @@
2222
<attribute name="maven.pomderived" value="true"/>
2323
</attributes>
2424
</classpathentry>
25+
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
26+
<attributes>
27+
<attribute name="maven.pomderived" value="true"/>
28+
</attributes>
29+
</classpathentry>
2530
<classpathentry kind="output" path="target/classes"/>
2631
</classpath>

‎doc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
src/main/resources/markdown

‎pom.xml‎

Lines changed: 66 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -16,63 +16,71 @@
1616
<name>OpenFastTrace</name>
1717
<description>Free software requirement tracing suite</description>
1818
<build>
19-
<pluginManagement>
20-
<plugins>
21-
<plugin>
22-
<groupId>com.ruleoftech</groupId>
23-
<artifactId>markdown-page-generator-plugin</artifactId>
24-
<version>2.1.0</version>
25-
<executions>
26-
<execution>
27-
<phase>generate-resources</phase>
28-
</execution>
29-
</executions>
30-
<configuration>
31-
<inputDirectory>${project.basedir}/doc</inputDirectory>
32-
</configuration>
33-
</plugin>
34-
<plugin>
35-
<groupId>org.codehaus.mojo</groupId>
36-
<artifactId>license-maven-plugin</artifactId>
37-
<version>1.16</version>
38-
<configuration>
39-
<verbose>false</verbose>
40-
<detail>true</detail>
41-
<licenseName>cc-by-4.0</licenseName>
42-
<licenseResolver>${project.basedir}/src/license</licenseResolver>
43-
<organizationName>itsallcode.org</organizationName>
44-
<inceptionYear>2018</inceptionYear>
45-
<excludes>
46-
</excludes>
47-
<failOnMissingHeader>true</failOnMissingHeader>
48-
<failIfWarning>true</failIfWarning>
49-
<failOnNotUptodateHeader>true</failOnNotUptodateHeader>
50-
<encoding>UTF-8</encoding>
51-
<dryRun>false</dryRun>
52-
</configuration>
53-
<executions>
54-
<execution>
55-
<id>check-file-header</id>
56-
<goals>
57-
<goal>check-file-header</goal>
58-
</goals>
59-
<phase>validate</phase>
60-
</execution>
61-
<execution>
62-
<id>first</id>
63-
<goals>
64-
<goal>update-file-header</goal>
65-
</goals>
66-
<phase>process-sources</phase>
67-
<configuration>
68-
<roots>
69-
<root>src/markdown</root>
70-
</roots>
71-
</configuration>
72-
</execution>
73-
</executions>
74-
</plugin>
75-
</plugins>
76-
</pluginManagement>
19+
<plugins>
20+
<plugin>
21+
<groupId>com.ruleoftech</groupId>
22+
<artifactId>markdown-page-generator-plugin</artifactId>
23+
<version>2.1.0</version>
24+
<executions>
25+
<execution>
26+
<phase>process-resources</phase>
27+
<goals>
28+
<goal>generate</goal>
29+
</goals>
30+
</execution>
31+
</executions>
32+
<configuration>
33+
<inputDirectory>${project.basedir}/src/main/resources/markdown</inputDirectory>
34+
<recursiveInput>true</recursiveInput>
35+
<inputFileExtensions>md, markdown</inputFileExtensions>
36+
<inputEncoding>UTF-8</inputEncoding>
37+
<outputEncoding>UTF-8</outputEncoding>
38+
<headerHtmlFile>${project.basedir}/src/main/resources/html/header.html</headerHtmlFile>
39+
<copyDirectories>${project.basedir}/src/main/resources/css/</copyDirectories>
40+
<transformRelativeMarkdownLinks>true</transformRelativeMarkdownLinks>
41+
</configuration>
42+
</plugin>
43+
<!-- plugin>
44+
<groupId>org.codehaus.mojo</groupId>
45+
<artifactId>license-maven-plugin</artifactId>
46+
<version>1.16</version>
47+
<configuration>
48+
<verbose>false</verbose>
49+
<detail>true</detail>
50+
<licenseName>cc-by-4.0</licenseName>
51+
<licenseResolver>${project.basedir}/src/license</licenseResolver>
52+
<organizationName>itsallcode.org</organizationName>
53+
<inceptionYear>2018</inceptionYear>
54+
<excludes>
55+
</excludes>
56+
<failOnMissingHeader>true</failOnMissingHeader>
57+
<failIfWarning>true</failIfWarning>
58+
<failOnNotUptodateHeader>true</failOnNotUptodateHeader>
59+
<encoding>UTF-8</encoding>
60+
<dryRun>false</dryRun>
61+
</configuration>
62+
<executions>
63+
<execution>
64+
<id>check-file-header</id>
65+
<goals>
66+
<goal>check-file-header</goal>
67+
</goals>
68+
<phase>validate</phase>
69+
</execution>
70+
<execution>
71+
<id>first</id>
72+
<goals>
73+
<goal>update-file-header</goal>
74+
</goals>
75+
<phase>process-sources</phase>
76+
<configuration>
77+
<roots>
78+
<root>src/markdown</root>
79+
</roots>
80+
</configuration>
81+
</execution>
82+
</executions>
83+
</plugin -->
84+
</plugins>
7785
</build>
7886
</project>

‎src/main/resources/css/spec.css‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
@CHARSET "UTF-8";
2+
3+
body {
4+
counter-reset: section;
5+
font-family: Helvetica, arial, sans-serif;
6+
font-size: 14px;
7+
line-height: 1.5;
8+
padding-top: 10px;
9+
padding-bottom: 10px;
10+
background-color: white;
11+
padding: 30px;
12+
color: #333;
13+
}
14+
15+
h1, h2, h3, h4 {
16+
border-style: none;
17+
text-decoration-line: none;
18+
}
19+
20+
h1:before {
21+
counter-increment: section;
22+
content: counter(section) " ";
23+
}
24+
25+
h1 {
26+
counter-reset: sub-section;
27+
font-size: 20px;
28+
border-bottom: 1px solid lightgrey;
29+
}
30+
31+
h2:before {
32+
counter-increment: sub-section;
33+
content: counter(section) "." counter(sub-section) " ";
34+
}
35+
36+
h2 {
37+
counter-reset: composite;
38+
font-size: 18px;
39+
}
40+
41+
h3:before {
42+
counter-increment: composite;
43+
content: counter(section) "." counter(sub-section) "."
44+
counter(composite) " ";
45+
}
46+
47+
h3 {
48+
counter-reset: detail;
49+
font-size: 16px;
50+
}
51+
52+
h4:before {
53+
counter-increment: detail;
54+
content: counter(section) "." counter(sub-section) "."
55+
counter(composite) "." counter(detail) " ";
56+
}
57+
58+
h4 {
59+
font-size: 14px;
60+
}
61+
62+
li {
63+
list-style-type: square;
64+
}
65+
66+
p {
67+
width: 100%;
68+
}
69+
70+
h1 + p > code:first-of-type,
71+
h2 + p > code:first-of-type,
72+
h3 + p > code:first-of-type,
73+
h4 + p > code:first-of-type,
74+
h5 + p > code:first-of-type,
75+
h6 + p > code:first-of-type {
76+
display: block;
77+
font-size: 12px;
78+
color: grey;
79+
border-bottom: 1px dotted lightgrey;
80+
text-align: right;
81+
width: 100%;
82+
position: relative;
83+
top: -2.5em;
84+
}

‎src/main/resources/html/header.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>titleToken</title>
5+
<meta charset="utf-8" />
6+
<link rel="stylesheet" href="##SITE_BASE##/spec.css">
7+
</head>

‎doc/architecture.md‎ renamed to ‎src/main/resources/markdown/architecture.md‎

File renamed without changes.

‎doc/bibliography.md‎ renamed to ‎src/main/resources/markdown/bibliography.md‎

File renamed without changes.

‎doc/context.md‎ renamed to ‎src/main/resources/markdown/context.md‎

File renamed without changes.

‎doc/glossary.md‎ renamed to ‎src/main/resources/markdown/glossary.md‎

File renamed without changes.

‎doc/introduction.md‎ renamed to ‎src/main/resources/markdown/introduction.md‎

File renamed without changes.

0 commit comments

Comments
 (0)