e15c05721e
Bump webrick in /docs in the all-gems group across 1 directory Bumps the all-gems group with 1 update in the /docs directory: [webrick](https://github.com/ruby/webrick). Updates `webrick` from 1.8.2 to 1.9.0 - [Release notes](https://github.com/ruby/webrick/releases) - [Commits](https://github.com/ruby/webrick/compare/v1.8.2...v1.9.0) --- updated-dependencies: - dependency-name: webrick dependency-type: direct:production update-type: version-update:semver-minor dependency-group: all-gems ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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/