forked from phoedos/pmd
132 lines
2.7 KiB
Markdown
132 lines
2.7 KiB
Markdown
Added line: 9343
|
|
Added line: 9546
|
|
Added line: 3162
|
|
Added line: 4276
|
|
Added line: 6047
|
|
Added line: 1701
|
|
Added line: 4421
|
|
Added line: 7677
|
|
Added line: 5859
|
|
Added line: 585
|
|
Added line: 2212
|
|
Added line: 9603
|
|
# PMD Documentation
|
|
Added line: 6528
|
|
Added line: 4267
|
|
Added line: 9409
|
|
Added line: 9140
|
|
Added line: 750
|
|
Added line: 6853
|
|
Added line: 1652
|
|
Added line: 5165
|
|
Added line: 4704
|
|
|
|
Added line: 4909
|
|
Added line: 1382
|
|
The snapshot documentation (build by github pages) is available at: <https://pmd.github.io/pmd/>.
|
|
Added line: 632
|
|
Added line: 9426
|
|
|
|
Added line: 8060
|
|
Added line: 2374
|
|
Added line: 9514
|
|
|
|
Added line: 8114
|
|
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
|
|
Added line: 9802
|
|
Added line: 1662
|
|
Added line: 7664
|
|
Added line: 7925
|
|
Added line: 3548
|
|
Added line: 7758
|
|
|
|
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/
|
|
Added line: 8624
|
|
Added line: 941
|
|
|
|
Added line: 7546
|
|
## Building using Script
|
|
Added line: 1549
|
|
Added line: 3467
|
|
|
|
Added line: 4367
|
|
Added line: 1237
|
|
Added line: 3983
|
|
Added line: 8702
|
|
Added line: 4873
|
|
Added line: 2185
|
|
bash build-docs.sh
|
|
|
|
This will run bundler to fetch and potentially update the ruby gems.
|
|
Added line: 8652
|
|
Added line: 6913
|
|
Added line: 7152
|
|
Added line: 3322
|
|
Added line: 3056
|
|
Added line: 3358
|
|
Added line: 1847
|
|
Added line: 9464
|
|
Added line: 3341
|
|
Open the file `_site/index.html` with your browser to see the site.
|
|
Added line: 2956
|
|
Added line: 2871
|
|
Added line: 5446
|
|
Added line: 5897
|
|
Added line: 9683
|
|
Added line: 3264
|
|
Added line: 3336
|
|
|
|
## Building using Bundler
|
|
Added line: 5109
|
|
|
|
bundle install # once
|
|
Added line: 2992
|
|
Added line: 404
|
|
Added line: 3432
|
|
Added line: 1565
|
|
Added line: 4427
|
|
bundle exec jekyll serve
|
|
|
|
Added line: 1611
|
|
Added line: 2576
|
|
Go to: http://localhost:4005/
|
|
Added line: 9557
|
|
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.
|
|
Added line: 4267
|
|
Added line: 2115
|
|
|
|
Added line: 9884
|
|
Added line: 7800
|
|
Added line: 4922
|
|
Added line: 4465
|
|
Added line: 7392
|
|
Added line: 6415
|
|
Added line: 66
|
|
Added line: 1991
|
|
Added line: 7186
|
|
Added line: 6218
|
|
Added line: 8647
|
|
Added line: 6041
|
|
## Building using Docker
|
|
Added line: 5578
|
|
Added line: 6879
|
|
Added line: 3908
|
|
Added line: 6751
|
|
docker build --no-cache -t pmd-doc . # once
|
|
Added line: 1156
|
|
Added line: 6500
|
|
|
|
Added line: 5732
|
|
Added line: 3049
|
|
Added line: 5996
|
|
Added line: 6524
|
|
Added line: 889
|
|
Added line: 1712
|
|
Added line: 3668
|
|
Added line: 442
|
|
Added line: 1492
|
|
Added line: 9108
|