diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 667a6876bd..994b58d435 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -6,8 +6,8 @@ GEM minitest (~> 5.1) thread_safe (~> 0.3, >= 0.3.4) tzinfo (~> 1.1) - addressable (2.5.1) - public_suffix (~> 2.0, >= 2.0.2) + addressable (2.5.2) + public_suffix (>= 2.0.2, < 4.0) coffee-script (2.4.1) coffee-script-source execjs @@ -16,21 +16,21 @@ GEM ethon (0.10.1) ffi (>= 1.3.0) execjs (2.7.0) - faraday (0.13.0) + faraday (0.13.1) multipart-post (>= 1.2, < 3) ffi (1.9.18) forwardable-extended (2.6.0) gemoji (3.0.0) - github-pages (151) + github-pages (158) activesupport (= 4.2.8) github-pages-health-check (= 1.3.5) - jekyll (= 3.5.1) + jekyll (= 3.5.2) jekyll-avatar (= 0.4.2) jekyll-coffeescript (= 1.0.1) jekyll-default-layout (= 0.1.4) jekyll-feed (= 0.9.2) jekyll-gist (= 1.4.1) - jekyll-github-metadata (= 2.6.0) + jekyll-github-metadata (= 2.9.1) jekyll-mentions (= 1.2.0) jekyll-optional-front-matter (= 0.2.0) jekyll-paginate (= 1.1.0) @@ -38,7 +38,7 @@ GEM jekyll-redirect-from (= 0.12.1) jekyll-relative-links (= 0.4.1) jekyll-sass-converter (= 1.5.0) - jekyll-seo-tag (= 2.2.3) + jekyll-seo-tag (= 2.3.0) jekyll-sitemap (= 1.0.0) jekyll-swiss (= 0.4.0) jekyll-theme-architect (= 0.1.0) @@ -50,7 +50,7 @@ GEM jekyll-theme-midnight (= 0.1.0) jekyll-theme-minimal (= 0.1.0) jekyll-theme-modernist (= 0.1.0) - jekyll-theme-primer (= 0.4.0) + jekyll-theme-primer (= 0.5.2) jekyll-theme-slate (= 0.1.0) jekyll-theme-tactile (= 0.1.0) jekyll-theme-time-machine (= 0.1.0) @@ -69,11 +69,11 @@ GEM octokit (~> 4.0) public_suffix (~> 2.0) typhoeus (~> 0.7) - html-pipeline (2.6.0) + html-pipeline (2.7.0) activesupport (>= 2) nokogiri (>= 1.4) i18n (0.8.6) - jekyll (3.5.1) + jekyll (3.5.2) addressable (~> 2.4) colorator (~> 1.0) jekyll-sass-converter (~> 1.0) @@ -94,7 +94,7 @@ GEM jekyll (~> 3.3) jekyll-gist (1.4.1) octokit (~> 4.2) - jekyll-github-metadata (2.6.0) + jekyll-github-metadata (2.9.1) jekyll (~> 3.1) octokit (~> 4.0, != 4.4.0) jekyll-mentions (1.2.0) @@ -112,7 +112,7 @@ GEM jekyll (~> 3.3) jekyll-sass-converter (1.5.0) sass (~> 3.4) - jekyll-seo-tag (2.2.3) + jekyll-seo-tag (2.3.0) jekyll (~> 3.3) jekyll-sitemap (1.0.0) jekyll (~> 3.3) @@ -144,8 +144,9 @@ GEM jekyll-theme-modernist (0.1.0) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.4.0) + jekyll-theme-primer (0.5.2) jekyll (~> 3.5) + jekyll-github-metadata (~> 2.9) jekyll-seo-tag (~> 2.2) jekyll-theme-slate (0.1.0) jekyll (~> 3.5) @@ -214,4 +215,4 @@ DEPENDENCIES jekyll BUNDLED WITH - 1.13.6 + 1.15.1 diff --git a/docs/README.md b/docs/README.md index 17c8437056..a183bdfa9a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,15 +7,16 @@ 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/ +## Building using Bundler -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 - -## Using Docker - -One time: `docker build --no-cache -t mydocs .` - -Now run the site with `docker run --rm=true -v "$PWD:/src" -p 4005:4005 mydocs serve -H 0.0.0.0` + bundle install # once + bundle exec jekyll serve + +Go to: http://localhost:4005/ + +## Building using Docker + + docker build --no-cache -t pmd-doc . # once + docker run --rm=true -v "$PWD:/src" -p 4005:4005 pmd-doc serve -H 0.0.0.0 Go to: http://localhost:4005/ diff --git a/docs/_config.yml b/docs/_config.yml index 67e10eb08d..2064c7c9d4 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -2,6 +2,7 @@ repository: pmd/pmd pmd: version: 6.0.0 + date: to-be-defined output: web # this property is useful for conditional filtering of content that is separate from the PDF. diff --git a/docs/_data/sidebars/pmd_sidebar.yml b/docs/_data/sidebars/pmd_sidebar.yml index 1effd4022e..c3099fd0ea 100644 --- a/docs/_data/sidebars/pmd_sidebar.yml +++ b/docs/_data/sidebars/pmd_sidebar.yml @@ -45,9 +45,20 @@ entries: - title: Suppressing url: /pmd_userdocs_suppressing.html output: web, pdf - - title: Tools / Integrations - url: /pmd_userdocs_tools.html - output: web, pdf + subfolders: + - title: Tools / Integrations + output: web, pdf + subfolderitems: + - title: Maven PMD Plugin + output: web, pdf + url: /pmd_userdocs_tools_maven.html + - title: Ant + output: web, pdf + url: /pmd_userdocs_tools_ant.html + - title: Other Tools / Integrations + output: web, pdf + url: /pmd_userdocs_tools.html + - title: FAQ url: /pmd_userdocs_faq.html output: web, pdf @@ -123,6 +134,12 @@ entries: - title: Developer Documentation output: web, pdf folderitems: + - title: Developer Resources + url: /pmd_devdocs_development.html + output: web, pdf + - title: Writing Documentation + url: /pmd_devdocs_writing_documentation.html + output: web, pdf - title: Code Style url: /pmd_devdocs_codestyle.html output: web, pdf diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html index 30adf87229..51bfa69a32 100644 --- a/docs/_includes/sidebar.html +++ b/docs/_includes/sidebar.html @@ -6,7 +6,11 @@ {% for folder in entry.folders %} {% if folder.output contains "web" %}
  • + {% if folder.url %} + {{ folder.title }} + {% else %} {{ folder.title }} + {% endif %}