pmd/docs/_config.yml

repository: pmd/pmd

pmd:
    version: 7.0.0-rc1
    previous_version: 6.55.0
    date: 25-March-2023
    release_type: major

# release types: major, minor, bugfix

output: web
# this property is useful for conditional filtering of content that is separate from the PDF.

topnav_title: PMD Source Code Analyzer Project
# this appears on the top navigation bar next to the home button

site_title: PMD Source Code Analyzer
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)

company_name: PMD Open Source Project
# this appears in the footer

github_editme_path: pmd/pmd/blob/master/docs/
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.

host: 127.0.0.1
# the preview server used. Leave as is.

port: 4005
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.

# these are the files and directories that jekyll will exclude from the build
exclude:
  - .idea/
  - .gitignore
  - vendor/
  - Gemfile
  - Gemfile.lock
  - README.md
  - Dockerfile
  - build-docs.sh
  - assets/*.zip
  - assets/README.md
  - pdf-*.sh
  - pdfconfigs/
  - pdf/
  - sitemap_generator.sh
  - render_release_notes.rb

feedback_subject_line: PMD Source Code Analyzer

feedback_email:
# used as a contact email for the Feedback link in the top navigation bar

feedback_disable: true
# if you uncomment the previous line, the Feedback link gets removed

# feedback_text: "Need help?"
# if you uncomment the previous line, it changes the Feedback text

# feedback_link: "http://helpy.io/"
# if you uncomment the previous line, it changes where the feedback link points to


markdown: kramdown
highlighter: rouge
kramdown:
  input: GFM
  auto_ids: true
  hard_wrap: false
  syntax_highlighter: rouge
  syntax_highlighter_opts:
      css_class: 'highlight'
# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways

collections:
  tooltips:
    output: false
# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true

defaults:
  -
    scope:
      path: ""
      type: "pages"
    values:
      layout: "page"
      comments: true
      search: true
      sidebar: pmd_sidebar
  -
    scope:
      path: ""
      type: "tooltips"
    values:
      layout: "page"
      comments: true
      search: true
      tooltip: true

  -
    scope:
      path: ""
      type: "posts"
    values:
      layout: "post"
      comments: true
      search: true
      sidebar: pmd_sidebar

# these are defaults used for the frontmatter for these file types

sidebars:
- pmd_sidebar

description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
# the description is used in the feed.xml file

# needed for sitemap.xml file only
url: https://pmd.github.io/pmd
baseurl: ""

# used by javadoc_tag.rb
# https://javadoc.io/page/net.sourceforge.pmd
javadoc_url_prefix: https://docs.pmd-code.org/apidocs