3ed370f61d
- Bump bundler from 2.5.3 to 2.5.22 - Bump activesupport from 7.2.1 to 7.2.2 - Bump execjs from 2.9.1 to 2.10.0 - Bump faraday from 2.11.0 to 2.12.0 - Bump i18n from 1.14.5 to 1.14.6 - Bump json from 2.7.2 to 2.7.5 - Bump logger from 1.6.0 to 1.6.1 - Bump rexml from 3.3.6/3.3.8 to 3.3.9 - Bump rufus-scheduler from 3.9.2 to 3.9.2 - Fixes https://github.com/pmd/pmd/security/dependabot/69 - Fixes https://github.com/pmd/pmd/security/dependabot/70
PMD Documentation
The snapshot documentation (build by github pages) is available at: https://pmd.github.io/pmd/.
The same documentation (build with our own scripts) is available at: https://docs.pmd-code.org/snapshot/.
The documentation for the latest release is at: https://docs.pmd-code.org/latest/
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/
Building using Script
bash build-docs.sh
This will run bundler to fetch and potentially update the ruby gems.
And then it will execute jekyll and build a offline site.
Open the file _site/index.html with your browser to see the site.
Building using Bundler
bundle install # once
bundle exec jekyll serve
Go to: http://localhost:4005/
This variant is useful to get constant updates: When you modify a file, jekyll will automatically rebuild the site, so you just need to hit Refresh in the browser to see the update.
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/