mkdocs.yml

site_name: NPM Groovy Lint
site_url: https://nvuillam.github.io/npm-groovy-lint
repo_url: https://github.com/nvuillam/npm-groovy-lint
edit_uri: tree/master/docs
site_author: Nicolas Vuillamy
# site_description-start
site_description: Linter, formatter and auto-fixer for Groovy, Jenkinsfile and Gradle files
# site_description-end
copyright: Copyright &copy; 2020 <a href="https://github.com/nvuillam">Nicolas Vuillamy</a>
# google_analytics: ["G-3DM50255LC", "nvuillam.github.io/nvuillam"]
theme:
  name: material
  features:
    - navigation.instant
    - navigation.expand
#    logo: assets/images/npm-groovy-lint-square.png
#    favicon: assets/images/npm-groovy-lint-square.png
markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - mdx_truly_sane_lists
extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - javascripts/tables.js
extra_css:
  - stylesheets/extra.css
extra:
  social:
    - icon: fontawesome/regular/circle-question
      link: https://github.com/nvuillam/npm-groovy-lint/issues
      title: Need help ? Post an issue :)
    - icon: fontawesome/brands/github
      link: https://github.com/nvuillam/npm-groovy-lint
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/nvuillam/npm-groovy-lint
  generator: false
nav:
  - "Home": "index.md"
  - "Usage": "./#usage"
  - "Installation": "./#installation"
  - "Configuration": "./#configuration"
  - "Examples": "./#example-calls"
  - "Disabling rules in source": "./#disabling-rules-in-source"
  - "Auto-fixable rules": "./#auto-fixable-rules"
  - "CI/CD": "./#cdci"
  - "Use as module": "./#use-as-module"
  - "Contribute": "./#contribute"
  - "Thanks": "./#thanks"
  - "Changelog": "CHANGELOG.md"