Skip to content

Commit b14da68

Browse files
adangeladangel
committed
1 parent b193bb2 commit b14da68

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+690
-438
lines changed

‎docs/Dockerfile

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
FROM ruby:2.1
2+
MAINTAINER [email protected]
3+
4+
RUN apt-get clean \
5+
&& mv /var/lib/apt/lists /var/lib/apt/lists.broke \
6+
&& mkdir -p /var/lib/apt/lists/partial
7+
8+
RUN apt-get update
9+
10+
RUN apt-get install -y \
11+
node \
12+
python-pygments \
13+
&& apt-get clean \
14+
&& rm -rf /var/lib/apt/lists/
15+
16+
WORKDIR /tmp
17+
ADD Gemfile /tmp/
18+
ADD Gemfile.lock /tmp/
19+
RUN bundle install
20+
21+
VOLUME /src
22+
EXPOSE 4000
23+
24+
WORKDIR /src
25+
ENTRYPOINT ["jekyll"]
26+

‎docs/Gemfile

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
source "https://rubygems.org"
22

3-
# gem "rails"
4-
gem 'github-pages'
5-
gem 'jekyll'
6-
gem 'wdm', '~> 0.1.0' if Gem.win_platform?
3+
gem 'github-pages', group: :jekyll_plugins
4+
gem 'wdm', '>= 0.1.0' if Gem.win_platform?

‎docs/Gemfile.lock

Lines changed: 108 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -7,54 +7,76 @@ GEM
77
minitest (~> 5.1)
88
thread_safe (~> 0.3, >= 0.3.4)
99
tzinfo (~> 1.1)
10-
addressable (2.4.0)
10+
addressable (2.5.0)
11+
public_suffix (~> 2.0, >= 2.0.2)
1112
coffee-script (2.4.1)
1213
coffee-script-source
1314
execjs
14-
coffee-script-source (1.10.0)
15+
coffee-script-source (1.12.2)
1516
colorator (1.1.0)
16-
ethon (0.9.0)
17+
ethon (0.10.1)
1718
ffi (>= 1.3.0)
1819
execjs (2.7.0)
19-
faraday (0.9.2)
20+
faraday (0.11.0)
2021
multipart-post (>= 1.2, < 3)
21-
ffi (1.9.14)
22-
ffi (1.9.14-x64-mingw32)
22+
ffi (1.9.17)
2323
forwardable-extended (2.6.0)
2424
gemoji (2.1.0)
25-
github-pages (94)
25+
github-pages (117)
2626
activesupport (= 4.2.7)
27-
github-pages-health-check (= 1.2.0)
28-
jekyll (= 3.2.1)
27+
github-pages-health-check (= 1.3.0)
28+
jekyll (= 3.3.1)
29+
jekyll-avatar (= 0.4.2)
2930
jekyll-coffeescript (= 1.0.1)
30-
jekyll-feed (= 0.5.1)
31+
jekyll-default-layout (= 0.1.4)
32+
jekyll-feed (= 0.8.0)
3133
jekyll-gist (= 1.4.0)
32-
jekyll-github-metadata (= 2.0.2)
34+
jekyll-github-metadata (= 2.3.1)
3335
jekyll-mentions (= 1.2.0)
36+
jekyll-optional-front-matter (= 0.1.2)
3437
jekyll-paginate (= 1.1.0)
38+
jekyll-readme-index (= 0.0.3)
3539
jekyll-redirect-from (= 0.11.0)
36-
jekyll-sass-converter (= 1.3.0)
37-
jekyll-seo-tag (= 2.0.0)
38-
jekyll-sitemap (= 0.10.0)
40+
jekyll-relative-links (= 0.2.1)
41+
jekyll-sass-converter (= 1.5.0)
42+
jekyll-seo-tag (= 2.1.0)
43+
jekyll-sitemap (= 0.12.0)
44+
jekyll-swiss (= 0.4.0)
45+
jekyll-theme-architect (= 0.0.3)
46+
jekyll-theme-cayman (= 0.0.3)
47+
jekyll-theme-dinky (= 0.0.3)
48+
jekyll-theme-hacker (= 0.0.3)
49+
jekyll-theme-leap-day (= 0.0.3)
50+
jekyll-theme-merlot (= 0.0.3)
51+
jekyll-theme-midnight (= 0.0.3)
52+
jekyll-theme-minimal (= 0.0.3)
53+
jekyll-theme-modernist (= 0.0.3)
54+
jekyll-theme-primer (= 0.1.7)
55+
jekyll-theme-slate (= 0.0.3)
56+
jekyll-theme-tactile (= 0.0.3)
57+
jekyll-theme-time-machine (= 0.0.3)
58+
jekyll-titles-from-headings (= 0.1.4)
3959
jemoji (= 0.7.0)
4060
kramdown (= 1.11.1)
4161
liquid (= 3.0.6)
4262
listen (= 3.0.6)
4363
mercenary (~> 0.3)
44-
minima (= 1.0.1)
64+
minima (= 2.0.0)
65+
nokogiri (= 1.6.8.1)
4566
rouge (= 1.11.1)
4667
terminal-table (~> 1.4)
47-
github-pages-health-check (1.2.0)
68+
github-pages-health-check (1.3.0)
4869
addressable (~> 2.3)
4970
net-dns (~> 0.8)
5071
octokit (~> 4.0)
51-
public_suffix (~> 1.4)
72+
public_suffix (~> 2.0)
5273
typhoeus (~> 0.7)
53-
html-pipeline (2.4.2)
74+
html-pipeline (2.5.0)
5475
activesupport (>= 2)
5576
nokogiri (>= 1.4)
5677
i18n (0.7.0)
57-
jekyll (3.2.1)
78+
jekyll (3.3.1)
79+
addressable (~> 2.4)
5880
colorator (~> 1.0)
5981
jekyll-sass-converter (~> 1.0)
6082
jekyll-watch (~> 1.1)
@@ -64,84 +86,118 @@ GEM
6486
pathutil (~> 0.9)
6587
rouge (~> 1.7)
6688
safe_yaml (~> 1.0)
89+
jekyll-avatar (0.4.2)
90+
jekyll (~> 3.0)
6791
jekyll-coffeescript (1.0.1)
6892
coffee-script (~> 2.2)
69-
jekyll-feed (0.5.1)
93+
jekyll-default-layout (0.1.4)
94+
jekyll (~> 3.0)
95+
jekyll-feed (0.8.0)
96+
jekyll (~> 3.3)
7097
jekyll-gist (1.4.0)
7198
octokit (~> 4.2)
72-
jekyll-github-metadata (2.0.2)
99+
jekyll-github-metadata (2.3.1)
73100
jekyll (~> 3.1)
74-
octokit (~> 4.0)
101+
octokit (~> 4.0, != 4.4.0)
75102
jekyll-mentions (1.2.0)
76103
activesupport (~> 4.0)
77104
html-pipeline (~> 2.3)
78105
jekyll (~> 3.0)
106+
jekyll-optional-front-matter (0.1.2)
107+
jekyll (~> 3.0)
79108
jekyll-paginate (1.1.0)
109+
jekyll-readme-index (0.0.3)
110+
jekyll (~> 3.0)
80111
jekyll-redirect-from (0.11.0)
81112
jekyll (>= 2.0)
82-
jekyll-sass-converter (1.3.0)
83-
sass (~> 3.2)
84-
jekyll-seo-tag (2.0.0)
85-
jekyll (~> 3.1)
86-
jekyll-sitemap (0.10.0)
113+
jekyll-relative-links (0.2.1)
114+
jekyll (~> 3.3)
115+
jekyll-sass-converter (1.5.0)
116+
sass (~> 3.4)
117+
jekyll-seo-tag (2.1.0)
118+
jekyll (~> 3.3)
119+
jekyll-sitemap (0.12.0)
120+
jekyll (~> 3.3)
121+
jekyll-swiss (0.4.0)
122+
jekyll-theme-architect (0.0.3)
123+
jekyll (~> 3.3)
124+
jekyll-theme-cayman (0.0.3)
125+
jekyll (~> 3.3)
126+
jekyll-theme-dinky (0.0.3)
127+
jekyll (~> 3.3)
128+
jekyll-theme-hacker (0.0.3)
129+
jekyll (~> 3.3)
130+
jekyll-theme-leap-day (0.0.3)
131+
jekyll (~> 3.3)
132+
jekyll-theme-merlot (0.0.3)
133+
jekyll (~> 3.3)
134+
jekyll-theme-midnight (0.0.3)
135+
jekyll (~> 3.3)
136+
jekyll-theme-minimal (0.0.3)
137+
jekyll (~> 3.3)
138+
jekyll-theme-modernist (0.0.3)
139+
jekyll (~> 3.3)
140+
jekyll-theme-primer (0.1.7)
141+
jekyll (~> 3.3)
142+
jekyll-theme-slate (0.0.3)
143+
jekyll (~> 3.3)
144+
jekyll-theme-tactile (0.0.3)
145+
jekyll (~> 3.3)
146+
jekyll-theme-time-machine (0.0.3)
147+
jekyll (~> 3.3)
148+
jekyll-titles-from-headings (0.1.4)
149+
jekyll (~> 3.3)
87150
jekyll-watch (1.5.0)
88151
listen (~> 3.0, < 3.1)
89152
jemoji (0.7.0)
90153
activesupport (~> 4.0)
91154
gemoji (~> 2.0)
92155
html-pipeline (~> 2.2)
93156
jekyll (>= 3.0)
94-
json (1.8.3)
157+
json (1.8.6)
95158
kramdown (1.11.1)
96159
liquid (3.0.6)
97160
listen (3.0.6)
98161
rb-fsevent (>= 0.9.3)
99162
rb-inotify (>= 0.9.7)
100163
mercenary (0.3.6)
101164
mini_portile2 (2.1.0)
102-
minima (1.0.1)
103-
minitest (5.9.0)
165+
minima (2.0.0)
166+
minitest (5.10.1)
104167
multipart-post (2.0.0)
105168
net-dns (0.8.0)
106-
nokogiri (1.6.8)
107-
mini_portile2 (~> 2.1.0)
108-
pkg-config (~> 1.1.7)
109-
nokogiri (1.6.8-x64-mingw32)
169+
nokogiri (1.6.8.1)
110170
mini_portile2 (~> 2.1.0)
111-
pkg-config (~> 1.1.7)
112-
octokit (4.3.0)
113-
sawyer (~> 0.7.0, >= 0.5.3)
171+
octokit (4.6.2)
172+
sawyer (~> 0.8.0, >= 0.5.3)
114173
pathutil (0.14.0)
115174
forwardable-extended (~> 2.6)
116-
pkg-config (1.1.7)
117-
public_suffix (1.5.3)
118-
rb-fsevent (0.9.7)
119-
rb-inotify (0.9.7)
175+
public_suffix (2.0.5)
176+
rb-fsevent (0.9.8)
177+
rb-inotify (0.9.8)
120178
ffi (>= 0.5.0)
121179
rouge (1.11.1)
122180
safe_yaml (1.0.4)
123-
sass (3.4.22)
124-
sawyer (0.7.0)
125-
addressable (>= 2.3.5, < 2.5)
126-
faraday (~> 0.8, < 0.10)
127-
terminal-table (1.7.0)
128-
unicode-display_width (~> 1.1)
181+
sass (3.4.23)
182+
sawyer (0.8.1)
183+
addressable (>= 2.3.5, < 2.6)
184+
faraday (~> 0.8, < 1.0)
185+
terminal-table (1.7.3)
186+
unicode-display_width (~> 1.1.1)
129187
thread_safe (0.3.5)
130188
typhoeus (0.8.0)
131189
ethon (>= 0.8.0)
132190
tzinfo (1.2.2)
133191
thread_safe (~> 0.1)
134-
unicode-display_width (1.1.0)
192+
unicode-display_width (1.1.3)
135193
wdm (0.1.1)
136194

137195
PLATFORMS
138196
ruby
139-
x64-mingw32
140197

141198
DEPENDENCIES
142199
github-pages
143-
jekyll
144-
wdm (~> 0.1.0)
200+
wdm (>= 0.1.0)
145201

146202
BUNDLED WITH
147-
1.12.5
203+
1.14.3

‎docs/_config.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
repository: pmd/pmd
12

23
output: web
34
# this property is useful for conditional filtering of content that is separate from the PDF.
@@ -11,7 +12,7 @@ site_title: PMD Source Code Analyzer
1112
company_name: PMD Open Source Project
1213
# this appears in the footer
1314

14-
github_editme_path:
15+
github_editme_path: pmd/pmd/blob/master/docs/
1516
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
1617

1718
disqus_shortname:

‎docs/_includes/custom/getting_started_series_next.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
<p>{% assign series_pages = site.tags.series_acme %}
32
{% for p in pages %}
43
{% if p.series == "Getting Started" %}

‎docs/_includes/custom/series_acme_next.html

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
1-
<p>{% assign series_pages = site.tags.series_acme %}
2-
{% for p in pages %}
3-
{% if p.series == "ACME series" %}
4-
{% assign nextTopic = page.weight | plus: "1" %}
5-
{% if p.weight == nextTopic %}
6-
<a href="{{p.url | remove: "/"}}"><button type="button" class="btn btn-primary">Next: {{p.weight}} {{p.title}}</button></a>
7-
{% endif %}
8-
{% endif %}
9-
{% endfor %}
10-
</p>
1+
<div class="seriesContext">
2+
<a>
3+
{% assign pages = site.pages | sort:"weight" %}
4+
{% for pg in pages %}
5+
{% if pg.series == "ACME series" %}
6+
{% if pg.weight > page.weight %}
7+
<a href="{{pg.url | remove: '/'}}"><button type="button" class="btn btn-primary">Next: {{pg.title}}</button></a>
8+
{% break %}
9+
{% endif %}
10+
{% endif %}
11+
{% endfor %}
12+
</a>
13+
&nbsp;
14+
<div class="btn-group">
15+
<button type="button" data-toggle="dropdown" class="btn btn-primary dropdown-toggle">Jump to: <span class="caret"></span></button>
16+
<ol class="dropdown-menu">
17+
{% for pg in pages %}
18+
{% if pg.series == "ACME series" %}
19+
{% if pg.url == page.url %}
20+
<li class="active"> → {{pg.weight}}. {{pg.title}}</li>
21+
{% else %}
22+
<li>
23+
<a href="{{pg.url | remove: '/'}}">{{pg.title}}</a>
24+
</li>
25+
{% endif %}
26+
{% endif %}
27+
{% endfor %}
28+
</ol>
29+
</div>
30+
</div>

‎docs/_includes/feedback.html

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,13 @@
1-
<li><a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:{{site.feedback_email}}?subject={{site.feedback_subject_line}} f eedback&body=I have some feedback about the {{page.title}} page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> Feedback</a><li>
1+
<li>
2+
{% if site.feedback_text %}
3+
{% assign feedback_text = site.feedback_text %}
4+
{% else %}
5+
{% assign feedback_text = "Feedback" %}
6+
{% endif %}
7+
8+
{% if site.feedback_link %}
9+
<a class="email" title="Submit feedback" href="{{site.feedback_link}}">{{feedback_text}}</a>
10+
{% else %}
11+
<a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:{{site.feedback_email}}?subject={{site.feedback_subject_line}} feedback&body=I have some feedback about the {{page.title}} page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> {{feedback_text}}</a>
12+
{% endif %}
13+
</li>

‎docs/_includes/footer.html

100644100755
File mode changed.

‎docs/_includes/head.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@
3333
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
3434
<![endif]-->
3535

36-
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "feed.xml" | prepend: site.url }}">
36+
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.url }}">

‎docs/_includes/image.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<figure>{% if {{include.url}} %}<a class="no_icon" target="_blank" href="{{include.url}}">{% endif %}<img class="docimage" src="images/{{include.file}}" alt="{{include.alt}}" {% if {{include.max-width}} %}style="max-width: {{include.max-width}}px"{% endif %} />{% if {{include.url}} %}</a>{% endif %}{% if {{include.caption}} %}<figcaption>{{include.caption}}</figcaption></figure>{% endif %}
1+
<figure>{% if {{include.url}} %}<a class="no_icon" target="_blank" href="{{include.url}}">{% endif %}<img class="docimage" src="images/{{include.file}}" alt="{{include.alt}}" {% if {{include.max-width}} %}style="max-width: {{include.max-width}}px"{% endif %} />{% if {{include.url}} %}</a>{% endif %}{% if {{include.caption}} %}<figcaption>{{include.caption}}</figcaption>{% endif %}</figure>

0 commit comments

Comments
 (0)