Add 'docs/' from commit '106142b25c9387ffd002437027ced1b04f494205'

git-subtree-dir: docs
git-subtree-mainline: 23545aa7ea
git-subtree-split: 106142b25c
This commit is contained in:
Andreas Dangel
2017-05-25 10:01:42 +02:00
243 changed files with 40754 additions and 0 deletions

5
docs/.gitignore vendored Normal file
View File

@ -0,0 +1,5 @@
_site/
.sass-cache/
.jekyll-metadata
_pdf
.idea/

6
docs/404.md Normal file
View File

@ -0,0 +1,6 @@
---
title: "Page Not Found"
search: exclude
---
Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct.

6
docs/Gemfile Normal file
View File

@ -0,0 +1,6 @@
source "https://rubygems.org"
# gem "rails"
gem 'github-pages'
gem 'jekyll'
gem 'wdm', '~> 0.1.0' if Gem.win_platform?

147
docs/Gemfile.lock Normal file
View File

@ -0,0 +1,147 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.7)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.4.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.10.0)
colorator (1.1.0)
ethon (0.9.0)
ffi (>= 1.3.0)
execjs (2.7.0)
faraday (0.9.2)
multipart-post (>= 1.2, < 3)
ffi (1.9.14)
ffi (1.9.14-x64-mingw32)
forwardable-extended (2.6.0)
gemoji (2.1.0)
github-pages (94)
activesupport (= 4.2.7)
github-pages-health-check (= 1.2.0)
jekyll (= 3.2.1)
jekyll-coffeescript (= 1.0.1)
jekyll-feed (= 0.5.1)
jekyll-gist (= 1.4.0)
jekyll-github-metadata (= 2.0.2)
jekyll-mentions (= 1.2.0)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.11.0)
jekyll-sass-converter (= 1.3.0)
jekyll-seo-tag (= 2.0.0)
jekyll-sitemap (= 0.10.0)
jemoji (= 0.7.0)
kramdown (= 1.11.1)
liquid (= 3.0.6)
listen (= 3.0.6)
mercenary (~> 0.3)
minima (= 1.0.1)
rouge (= 1.11.1)
terminal-table (~> 1.4)
github-pages-health-check (1.2.0)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 1.4)
typhoeus (~> 0.7)
html-pipeline (2.4.2)
activesupport (>= 2)
nokogiri (>= 1.4)
i18n (0.7.0)
jekyll (3.2.1)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-feed (0.5.1)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-github-metadata (2.0.2)
jekyll (~> 3.1)
octokit (~> 4.0)
jekyll-mentions (1.2.0)
activesupport (~> 4.0)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.11.0)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-seo-tag (2.0.0)
jekyll (~> 3.1)
jekyll-sitemap (0.10.0)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
jemoji (0.7.0)
activesupport (~> 4.0)
gemoji (~> 2.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
json (1.8.3)
kramdown (1.11.1)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9.7)
mercenary (0.3.6)
mini_portile2 (2.1.0)
minima (1.0.1)
minitest (5.9.0)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.6.8)
mini_portile2 (~> 2.1.0)
pkg-config (~> 1.1.7)
nokogiri (1.6.8-x64-mingw32)
mini_portile2 (~> 2.1.0)
pkg-config (~> 1.1.7)
octokit (4.3.0)
sawyer (~> 0.7.0, >= 0.5.3)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
pkg-config (1.1.7)
public_suffix (1.5.3)
rb-fsevent (0.9.7)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
rouge (1.11.1)
safe_yaml (1.0.4)
sass (3.4.22)
sawyer (0.7.0)
addressable (>= 2.3.5, < 2.5)
faraday (~> 0.8, < 0.10)
terminal-table (1.7.0)
unicode-display_width (~> 1.1)
thread_safe (0.3.5)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
unicode-display_width (1.1.0)
wdm (0.1.1)
PLATFORMS
ruby
x64-mingw32
DEPENDENCIES
github-pages
jekyll
wdm (~> 0.1.0)
BUNDLED WITH
1.12.5

13
docs/README.md Normal file
View File

@ -0,0 +1,13 @@
# PMD-New-Site
New Site For PMD Core Open Source Project
## Site Theme
This site was built using the tomjohnson1492/documentation-theme-jekyll theme
A Jekyll-based theme designed for documentation and help systems. See the link for detailed instructions on setting up and configuring everything. http://idratherbewriting.com/documentation-theme-jekyll/
Build the site to see the instructions for using it. Or just go here: [http://idratherbewriting.com/documentation-theme-jekyll/](http://idratherbewriting.com/documentation-theme-jekyll/)
Run `bundle exec jekyll serve --watch` to fire up Jekyll on local machine

104
docs/_config.yml Normal file
View File

@ -0,0 +1,104 @@
output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
topnav_title: PMD Source Code Analyzer Project
# this appears on the top navigation bar next to the home button
site_title: PMD Source Code Analyzer
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
company_name: PMD Open Source Project
# this appears in the footer
github_editme_path:
# 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.
disqus_shortname:
# if you're using disqus for comments, add the shortname here. if not, leave this value blank.
host: 127.0.0.1
# the preview server used. Leave as is.
port: 4005
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.
exclude:
- .idea/
- .gitignore
# these are the files and directories that jekyll will exclude from the build
feedback_subject_line: PMD Source Code Analyzer
feedback_email:
# used as a contact email for the Feedback link in the top navigation bar
# feedback_disable: true
# if you uncomment the previous line, the Feedback link gets removed
# feedback_text: "Need help?"
# if you uncomment the previous line, it changes the Feedback text
# feedback_link: "http://helpy.io/"
# if you uncomment the previous line, it changes where the feedback link points to
highlighter: rouge
# library used for syntax highlighting
markdown: kramdown
kramdown:
input: GFM
auto_ids: true
hard_wrap: false
syntax_highlighter: rouge
# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways
collections:
tooltips:
output: false
# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
comments: true
search: true
sidebar: home_sidebar
-
scope:
path: ""
type: "tooltips"
values:
layout: "page"
comments: true
search: true
tooltip: true
-
scope:
path: ""
type: "posts"
values:
layout: "post"
comments: true
search: true
sidebar: home_sidebar
# these are defaults used for the frontmatter for these file types
sidebars:
- home_sidebar
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
- other
description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
# the description is used in the feed.xml file
# needed for sitemap.xml file only
url: http://idratherbewriting.com

15
docs/_data/alerts.yml Normal file
View File

@ -0,0 +1,15 @@
tip: '<div class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip: </b>'
note: '<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>'
important: '<div class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important: </b>'
warning: '<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning: </b>'
end: '</div>'
callout_danger: '<div class="bs-callout bs-callout-danger">'
callout_default: '<div class="bs-callout bs-callout-default">'
callout_primary: '<div class="bs-callout bs-callout-primary">'
callout_success: '<div class="bs-callout bs-callout-success">'
callout_info: '<div class="bs-callout bs-callout-info">'
callout_warning: '<div class="bs-callout bs-callout-warning">'
hr_faded: '<hr class="faded"/>'
hr_shaded: '<hr class="shaded"/>'

View File

@ -0,0 +1,9 @@
elephant: "This is a sample definition."
baseball: "Baseball is considered America's pasttime sport, though that may be more of a historical term than a current one. There's a lot more excitement about football than baseball. A baseball game is somewhat of a snooze to watch, for the most part."
basketball: "Basketball is a sport involving two teams of five players each competing to put a ball through a small circular rim 10 feet above the ground. Basketball requires players to be in top physical condition, since they spend most of the game running back and forth along a 94-foot-long floor."
football: "No doubt the most fun sport to watch, football also manages to accrue the most injuries with the players. From concussions to blown knees, football players have short sport lives."
soccer: "If there's one sport that dominates the world landscape, it's soccer. However, US soccer fans are few and far between. Apart from the popularity of soccer during the World Cup, most people don't even know the name of the professional soccer organization in their area."

11
docs/_data/glossary.yml Normal file
View File

@ -0,0 +1,11 @@
jekyll_platform: "Jekyll is a static site generator that builds sites using most modern web technologies."
fractious: "Like a little mischevious child, full of annoying and constant trouble."
gratuitous: "Something that is unwarranted and uncouth, like the social equivalent of a flagrant foul."
haughty: "Proud and flaunting it. Holding your head high up like a snooty, too-good-for-everything rich person."
impertinent: "Someone acting rude and insensitive to others."
intrepid: "Brave and courageous especially in a difficult, dangerous situation."

107
docs/_data/samplelist.yml Normal file
View File

@ -0,0 +1,107 @@
entries:
- title: Sidebar
folders:
- title: Food
folderitems:
- title: Bananas
url: bananas.html
subfolder:
- title: Apples
subfolderitems:
- title: Fuji apples
url: fuji_apples.html
- title: Gala apples
url: gala_apples.html
name:
husband: Tom
wife: Shannon
bikes:
- title: mountain bikes
- title: road bikes
- title: hybrid bikes
salesteams:
- title: Regions
subfolderitems:
- location: US
- location: Spain
- location: France
toc:
- title: Group 1
subfolderitems:
- page: Thing 1
- page: Thing 2
- page: Thing 3
- title: Group 2
subfolderitems:
- page: Piece 1
- page: Piece 2
- page: Piece 3
- title: Group 3
subfolderitems:
- page: Widget 1
- page: Widget 2
- page: Widget 3
something: &hello Greetings earthling!
myref: *hello
about:
- zero
- one
- two
- three
numbercolors:
- zero:
properties: red
- one:
properties: yellow
- two:
properties: green
- three:
properties: blue
mypages:
- section1: Section 1
audience: developers
product: acme
url: facebook.com
- section2: Section 2
audience: writers
product: acme
url: google.com
- section3: Section 3
audience: developers
product: acme
url: amazon.com
- section4: Section 4
audience: writers
product: gizmo
url: apple.com
- section5: Section 5
audience: writers
product: acme
url: microsoft.com
feedback: >
This is my feedback to you.
Even if I include linebreaks here,
all of the linebreaks will be removed when the value is inserted.
block: |
This pipe does something a little different.
It preserves the breaks.
This is really helpful for code samples,
since you can format the code samples with
the appropriate
white spacing.

View File

@ -0,0 +1,22 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
entries:
- title: Sidebar
levels: one
folders:
- title: Products
output: web
folderitems:
- title: News
url: /news.html
output: web
- title: Theme instructions
url: /mydoc_introduction.html
output: web
- title: Product 1
url: /p1_landing_page.html
output: web
- title: Product 2
url: /p2_landing_page.html
output: web

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,18 @@
# Follow the pattern here for the URLs -- no slash at the beginning, and include the .html. The link here is rendered exactly as is in the Markdown references.
entries:
- title: other
folders:
- title: Other Links
folderitems:
- title: Automated links bookmark
url: /mydoc_hyperlinks.html#automatedlinks
- title: Bookmark links
url: /mydoc_hyperlinks.html#bookmarklinks
- title: Some link bookmark
url: /mydoc_pages.html#someIdTag

View File

@ -0,0 +1,60 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
entries:
- title: Sidebar
product: Product1
version: 1.0
folders:
- title:
output: pdf
type: frontmatter
folderitems:
- title:
url: /titlepage
output: pdf
type: frontmatter
- title:
url: /tocpage
output: pdf
type: frontmatter
- title: Getting Started
output: web, pdf
folderitems:
- title: Product 1 home
url: /p1_landing_page.html
output: web
- title: Sample 1
url: /p1_sample1.html
output: web, pdf
- title: Sample 2
url: /p1_sample2.html
output: web, pdf
- title: Sample 3
url: /p1_sample3.html
output: web, pdf
- title: Another heading
output: web, pdf
folderitems:
- title: Sample 4
url: /p1_sample4.html
output: web, pdf
- title: Sample 5
url: /p1_sample5.html
output: web, pdf
- title: Sample 6
url: /p1_sample6.html
output: web, pdf
- title: Sample 7
url: /p1_sample7.html
output: web, pdf

View File

@ -0,0 +1,92 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
entries:
- title: Product2
product: Product2
version: 1.0
folders:
- title:
output: pdf
type: frontmatter
folderitems:
- title:
url: /titlepage
output: pdf
type: frontmatter
- title:
url: /tocpage
output: pdf
type: frontmatter
- title: Introduction
output: web, pdf
folderitems:
- title: Overview
url: /p2_landing_page.html
output: web
- title: Simple Workflow
output: web, pdf
folderitems:
- title: Sample 1
url: /p2_sample1.html
output: web, pdf
- title: Sample 2
url: /p2_sample2.html
output: web, pdf
- title: Sample 3
url: /p2_sample3.html
output: web, pdf
- title: Sample 4
url: /p2_sample4.html
output: web, pdf
- title: Sample 5
url: /p2_sample5.html
output: web, pdf
- title: Complex Workflow
output: web, pdf
folderitems:
- title: Sample 6
url: /p2_sample6.html
output: web, pdf
- title: Sample 7
url: /p2_sample7.html
output: web, pdf
- title: Sample 8
url: /p2_sample8.html
output: web, pdf
- title: Sample 9
url: /p2_sample9.html
output: web, pdf
- title: Sample 10
url: /p2_sample10.html
output: web, pdf
- title: Sample 11
url: /p2_sample11.html
output: web, pdf
- title: Sample 12
url: /p2_sample12.html
output: web, pdf
- title: Sample 13
url: /p2_sample13.html
output: web, pdf
- title: Sample 14
url: /p2_sample14.html
output: web, pdf

5
docs/_data/strings.yml Normal file
View File

@ -0,0 +1,5 @@
# placed here for translation purposes
search_placeholder_text: search...
search_no_results_text: No results found.

15
docs/_data/tags.yml Normal file
View File

@ -0,0 +1,15 @@
allowed-tags:
- getting_started
- release_notes
- content_types
- navigation
- formatting
- publishing
- single_sourcing
- special_layouts
- collaboration
- news
- troubleshooting
- mobile
- customizing
- languages

1
docs/_data/terms.yml Normal file
View File

@ -0,0 +1 @@
apple: "apple - the fruit of a disiduous tree."

32
docs/_data/topnav.yml Normal file
View File

@ -0,0 +1,32 @@
## Topnav single links
## if you want to list an external url, use external_url instead of url. the theme will apply a different link base.
topnav:
- title: Topnav
items:
- title: News
url: /news
#Topnav dropdowns
topnav_dropdowns:
- title: Topnav dropdowns
folders:
- title: Jekyll Resources
folderitems:
- title: Github Repo
external_url: https://github.com/tomjohnson1492/documentation-theme-jekyll
- title: Jekyll Talk
external_url: https://talk.jekyllrb.com
- title: Jekyll documentation
external_url: http://jekyllrb.com/docs/home/
- title: Jekyll on Stack Overflow
external_url: http://stackoverflow.com/questions/tagged/jekyll
- title: Jekyll on my blog
external_url: http://idratherbewriting.com/category-jekyll/
- title: Products
folderitems:
- title: Jekyll Documentation Theme
url: /mydoc_introduction.html
- title: Product 1
url: /p1_landing_page.html
- title: Product 2
url: /p2_landing_page.html

View File

@ -0,0 +1,15 @@
---
layout: default
type: archive
---
<div class="post-header">
<h1 class="post-title-main">{{ page.title }}</h1>
</div>
<div class="post-content">
{{ content }}
</div>

View File

@ -0,0 +1 @@
<div markdown="span" class="bs-callout bs-callout-{{include.type}}">{{include.content}}</div>

View File

@ -0,0 +1,19 @@
<div class="seriesContext">
<div class="btn-group">
<button type="button" data-toggle="dropdown" class="btn btn-primary dropdown-toggle">Getting Started <span class="caret"></span></button>
<ol class="dropdown-menu">
{% assign pages = site.pages | sort:"weight" %}
{% for p in pages %}
{% if p.series == "Getting Started" %}
{% if p.url == page.url %}
<li class="active"> → {{p.title}}</li>
{% else %}
<li>
<a href="{{p.url | remove: "/"}}">{{p.title}}</a>
</li>
{% endif %}
{% endif %}
{% endfor %}
</ol>
</div>
</div>

View File

@ -0,0 +1,11 @@
<p>{% assign series_pages = site.tags.series_acme %}
{% for p in pages %}
{% if p.series == "Getting Started" %}
{% assign nextTopic = page.weight | plus: "1" %}
{% if p.weight == nextTopic %}
<a href="{{p.url | remove: "/"}}"><button type="button" class="btn btn-primary">Next: {{p.title}}</button></a>
{% endif %}
{% endif %}
{% endfor %}
</p>

View File

@ -0,0 +1,19 @@
<div class="seriesContext">
<div class="btn-group">
<button type="button" data-toggle="dropdown" class="btn btn-primary dropdown-toggle">Series Demo <span class="caret"></span></button>
<ol class="dropdown-menu">
{% assign pages = site.pages | sort:"weight" %}
{% for p in pages %}
{% if p.series == "ACME series" %}
{% if p.url == page.url %}
<li class="active"> → {{p.weight}}. {{p.title}}</li>
{% else %}
<li>
<a href="{{p.url | remove: "/"}}">{{p.weight}}. {{p.title}}</a>
</li>
{% endif %}
{% endif %}
{% endfor %}
</ol>
</div>
</div>

View File

@ -0,0 +1,10 @@
<p>{% assign series_pages = site.tags.series_acme %}
{% for p in pages %}
{% if p.series == "ACME series" %}
{% assign nextTopic = page.weight | plus: "1" %}
{% if p.weight == nextTopic %}
<a href="{{p.url | remove: "/"}}"><button type="button" class="btn btn-primary">Next: {{p.weight}} {{p.title}}</button></a>
{% endif %}
{% endif %}
{% endfor %}
</p>

View File

@ -0,0 +1,19 @@
<div class="seriesContext">
<div class="btn-group">
<button type="button" data-toggle="dropdown" class="btn btn-primary dropdown-toggle">Customizing PMD<span class="caret"></span></button>
<ol class="dropdown-menu">
{% assign pages = site.pages | sort:"weight" %}
{% for p in pages %}
{% if p.series == "Customizing PMD" %}
{% if p.url == page.url %}
<li class="active"> → {{p.weight}}. {{p.short_title}}</li>
{% else %}
<li>
<a href="{{p.url | remove: "/"}}">{{p.weight}}. {{p.short_title}}</a>
</li>
{% endif %}
{% endif %}
{% endfor %}
</ol>
</div>
</div>

View File

@ -0,0 +1,10 @@
<p>{% assign series_pages = site.tags.series_customizing %}
{% for p in pages %}
{% if p.series == "Customizing PMD" %}
{% assign nextTopic = page.weight | plus: "1" %}
{% if p.weight == nextTopic %}
<a href="{{p.url | remove: "/"}}"><button type="button" class="btn btn-primary">Next: {{p.weight}} {{p.short_title}}</button></a>
{% endif %}
{% endif %}
{% endfor %}
</p>

View File

@ -0,0 +1,10 @@
<p>{% assign series_pages = site.tags.series_customizing %}
{% for p in pages %}
{% if p.series == "Customizing PMD" %}
{% assign prevTopic = page.weight | minus: "1" %}
{% if p.weight == prevTopic %}
<a href="{{p.url | remove: "/"}}"><button type="button" class="btn btn-primary">Previous: {{p.weight}} {{p.short_title}}</button></a>
{% endif %}
{% endif %}
{% endfor %}
</p>

View File

@ -0,0 +1,33 @@
{% if page.sidebar == "home_sidebar" %}
{% assign sidebar = site.data.sidebars.home_sidebar.entries %}
{% elsif page.sidebar == "product1_sidebar" %}
{% assign sidebar = site.data.sidebars.product1_sidebar.entries %}
{% elsif page.sidebar == "product2_sidebar" %}
{% assign sidebar = site.data.sidebars.product2_sidebar.entries %}
{% elsif page.sidebar == "mydoc_sidebar" %}
{% assign sidebar = site.data.sidebars.mydoc_sidebar.entries %}
{% else %}
{% assign sidebar = site.data.sidebars.home_sidebar.entries %}
{% endif %}
{% comment %}
sidebar configuration for print files
{% endcomment %}
{% if site.product == "mydoc" %}
{% assign sidebar_pdf = site.data.sidebars.mydoc_sidebar.entries %}
{% endif %}
{% if site.product == "product1" %}
{% assign sidebar_pdf = site.data.sidebars.product1_sidebar.entries %}
{% endif %}
{% if site.product == "product2" %}
{% assign sidebar_pdf = site.data.sidebars.product2_sidebar.entries %}
{% endif %}

View File

@ -0,0 +1,14 @@
<div id="userMap">
<div class="content"><a href="p2_sample1.html"><div class="box box1">Connect to ADB</div></a></div>
<div class="arrow"></div>
<div class="content"><a href="p2_sample2.html"><div class="box box2">Download and Build the Starter Kit</div></a></div>
<div class="arrow"></div>
<div class="content"><a href="p2_sample3.html"><div class="box box3">Take a Tour</div></a></div>
<div class="arrow"></div>
<div class="content"><a href="p2_sample4.html"><div class="box box4">Load Your Widgets</div></a></div>
<div class="arrow"></div>
<div class="content"><a href="p2_sample5.html"><div class="box box5">Query for Something</div></a></div>
<div class="clearfix"></div>
</div>

Some files were not shown because too many files have changed in this diff Show More