pmd/docs/README.md

39 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

# PMD Documentation
2023-03-30 15:28:56 +02:00
The snapshot documentation (build by github pages) is available at: <https://pmd.github.io/pmd/>.
2023-03-30 15:28:56 +02:00
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.
2017-08-18 19:06:39 +02:00
## Building using Bundler
2017-08-18 19:06:39 +02:00
bundle install # once
bundle exec jekyll serve
2017-08-18 19:06:39 +02:00
Go to: http://localhost:4005/
2017-05-25 11:12:17 +02:00
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.
2017-08-18 19:06:39 +02:00
## Building using Docker
2017-05-25 11:12:17 +02:00
2017-08-18 19:06:39 +02:00
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
2017-05-25 11:12:17 +02:00
Go to: http://localhost:4005/