Skip to content

Files

Latest commit

a0818d5 · Oct 4, 2024

History

History
This branch is 1394 commits behind pmd/pmd:main.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Sep 13, 2024
Jun 20, 2024
Aug 10, 2023
Mar 14, 2024
Apr 28, 2023
Mar 21, 2024
Apr 19, 2024
Aug 10, 2023
May 25, 2017
Oct 4, 2024
Sep 26, 2024
Sep 18, 2020
May 23, 2018
Dec 15, 2017
Mar 12, 2024
Sep 26, 2024
Mar 30, 2023
Sep 27, 2024
Jul 31, 2020
May 25, 2017
May 3, 2024
Mar 14, 2024
Apr 9, 2018
Mar 30, 2023

README.md

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/