Menu
▾
▴
Tree [315de4] main / docs / History
Andreas Dangel
Zbynek Konecny
Clément Fournier
![dependabot[bot]](https://secure.gravatar.com/avatar/48ea49be76d0c68403a7f3df87e3487d?size=16&r=pg&d=https%3A%2F%2Fsiteproxy.ruqli.workers.dev%3A443%2Fhttps%2Fa.fsdn.com%2Fcon%2Fimages%2Fsandiego%2Ficons%2Fdefault-avatar.png "dependabot[bot]")
dependabot[bot]
Read Me
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/
