mkdocs.yml

# Refer to https://github.com/mkdocs/mkdocs/blob/master/mkdocs.yml for a working example
site_name: Ethereum Smart Contract Best Practices
site_url: https://consensys.github.io/smart-contract-best-practices/
site_description: Ethereum Smart Contract Security Best Practices
site_author: ConsenSys Diligence
repo_url: https://github.com/ConsenSys/smart-contract-best-practices
repo_name: Github
remote_branch: gh-pages
remote_name: origin

nav:
  - Home: index.md
  - General Philosophy: general_philosophy.md
  - Secure Development Recommendations: recommendations.md
  - Known Attacks: known_attacks.md
  - Software Engineering Techniques: software_engineering.md
  - Token specific recommendations: tokens.md
  - Documentation and Procedures: documentation_procedures.md
  - Security Tools: security_tools.md
  - Bug Bounty Programs: bug_bounty_list.md
  - About:
    - Reviewers: about/reviewers.md
    - License: about/license.md
    - Contributing: about/contributing.md

theme:
  name: 'material'
  custom_dir: 'custom'
  logo: 'assets/images/CDili.png'
  favicon: 'assets/images/CDili_black.png'
  language: en
  features:
    - navigation.instant
    - header.autohide
    - navigation.sections
    - navigation.top
  palette: 
    - scheme: default
      primary: black
      accent: deep-purple
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
    - scheme: slate
      primary: black
      accent: cyan
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode

extra_css:
  - 'stylesheets/extra.css'

extra:
  social:
    - icon: fontawesome//solid/shield-alt
      link: https://consensys.net/diligence/blog/
    - icon: fontawesome/brands/github
      link: https://github.com/ConsenSys/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/ConsenSysAudits
    - icon: fontawesome/brands/medium
      link: https://medium.com/consensys-diligence
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCkoGLA5DUdXO4Qfo_9RDjIA/playlists

  analytics:
    provider: google
    property: UA-64552723-12
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.critic:
      mode: view
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - def_list
  - footnotes
  - meta
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tilde
  - markdown_include.include