mkdocs.yml

site_name: Polkadot Developer Docs
site_url: https://docs.polkadot.com/
home_url: https://polkadot.com/
home_name: Polkadot
edit_uri: https://github.com/polkadot-developers/polkadot-docs/edit/master
site_dir: /var/www/polkadot-docs-static
docs_dir: polkadot-docs
copyright: © 2024
extra_javascript:
  - js/header-scroll.js
  - js/search-bar-results.js
  - js/root-level-sections.js
  - js/fix-created-date.js
# Extra CSS files
extra_css:
  - assets/stylesheets/extra.css
  - assets/stylesheets/terminal.css
# Diagnostic messages when validating links to documents
validation:
  absolute_links: ignore
  unrecognized_links: ignore
# Theme related settings
theme:
  name: material
  custom_dir: material-overrides
  favicon: assets/images/favicon.webp
  logo: assets/images/logo.webp
  font:
    text: Manrope
  features:
    - content.code.annotate # Adds annotations to code blocks
    - content.code.copy # Adds copy to clipboard button to code snippets
    - content.tooltips # Adds tooltips
    - navigation.footer # Shows previous and next on the footer
    - navigation.tabs # Top-level sections are rendered below the header (can be modified to in-line with CSS)
    - navigation.tabs.sticky # When scrolling, the tabs remain at the top of the page
    - navigation.sections # Render top-level sections as groups in the sidebar
    - navigation.indexes # Index pages
    - navigation.top # Show the back to top button since we don't keep top nav sticky
    - content.action.edit
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - codehilite
  - md_in_html
  - meta
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: True
      line_spans: __span
      pygments_lang_class: True
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.snippets:
      base_path: polkadot-docs/.snippets
      url_download: True
      dedent_subsections: True
  - pymdownx.tabbed:
      alternate_style: True
  - toc:
      title: ' '
      permalink: True
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search
  - awesome-pages
  - redirects:
      redirect_maps:
        # Redirects will go here as pages get moved around in the following format:
        # old-page.md: new-page.md
  - macros:
      include_yaml:
        - polkadot-docs/variables.yml
  - git-revision-date-localized:
      type: date
      enable_creation_date: true
      exclude:
        - node_modules/*
      enabled: !ENV [ENABLED_GIT_REVISION_DATE, True]
extra:
  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.
      By consenting to the use of cookies, you help us improve the site. Review the <a href="https://docs.polkadot.com/cookie-policy/" target="_blank" rel="noopener">cookie policy</a> for more information. 
    actions:
      - accept
      - manage
  generator: False
  social:
    - icon: fontawesome/brands/discord
      link: https://dot.li/discord
      name: Discord
    - icon: fontawesome/brands/github
      link: https://github.com/paritytech/polkadot-sdk
      name: GitHub
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCB7PbjuZLEba_znc7mEGNgw
      name: YouTube
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/Polkadot
      name: Twitter
  analytics:
    provider: google
    property: G-ZSKWB953ZL
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by submitting
            <a href="https://docs.google.com/forms/d/e/1FAIpQLSdZR0p70uR78JVemft66VuL39-k6Mge9rufGZyYBeEhezF3iw/viewform?usp=pp_url&entry.1469237372=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">additional feedback</a>.