mkdocs.yml

site_name: Curve Resources
site_url: https://resources.curve.fi/
site_author: CurveFi
docs_dir: 'docs/en'

plugins:
  - search
  - autolinks
  - typeset
  - minify:
      minify_html: true


# extension
markdown_extensions:
  - footnotes
  - def_list
  - attr_list
  - md_in_html
  - admonition
  - meta
  - toc:
      permalink: true
      baselevel: 2
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.smartsymbols
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true

theme:
  name: material
  language: en
  custom_dir: overrides
  include_search_page: false
  search_index_only: true
  font:
    text: Roboto
    code: Roboto Mono
  logo: "images/lama.png"
  favicon: "images/lama.png"
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - content.tabs.link
    - content.footnote.tooltips
    - navigation.indexes
    - navigation.path
    - navigation.top
    - navigation.tracking
    - toc.follow
    - content.code.copy

  palette:
    # - media: "(prefers-color-scheme: dark)"
    - scheme: default
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # - media: "(prefers-color-scheme: light)"
    - scheme: slate
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to light mode

extra:
  generator: false
  social:
    - icon: fontawesome/brands/telegram
      link: https://t.me/curvefi
      name: Telegram
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/curvefinance
      name: X
    - icon: fontawesome/brands/discord
      link: https://discord.gg/rgrfS7W
      name: Discord
    - icon: fontawesome/brands/youtube
      link: http://www.youtube.com/c/CurveFinance
      name: YouTube
  alternate:
    - name: English
      link: "/"
      lang: en
    - name: Русский
      link: "/ru/"
      lang: ru

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

repo_name: CurveDocs/curve-resources
repo_url: https://github.com/CurveDocs/curve-resources


nav:
  - Home: index.md
  - Getting Started with Curve: getting-started.md
  - CRV Token:
    - Overview & Tokenomics: crv-token/overview.md
    - Supply & Distribution: crv-token/supply-distribution.md
    - CRV & veCRV FAQ: crv-token/faq.md
  - Locked CRV (veCRV):
    - Overview: vecrv/overview.md
    - How to Lock CRV: vecrv/locking-your-crv.md
    - Claiming Trading Fees: vecrv/claiming-trading-fees.md
    - Fee Collection & Distribution: vecrv/fee-collection-distribution.md
  - Curve Stablecoin (crvUSD):
    - Understanding crvUSD: crvusd/understanding-crvusd.md
    - Loan Creation & Management: crvusd/loan-creation.md
    - Liquidations: crvusd/liquidations.md
    - Leverage: lending/leverage.md
    - Loan Strategies: crvusd/loan-strategies.md
    - Loan Concepts In Depth: crvusd/loan-concepts.md
    - crvUSD FAQ: crvusd/faq.md
    - Savings-crvUSD (scrvUSD): crvusd/scrvusd.md
  - Curve Lending:
    - Overview: lending/overview.md
    - Leverage: lending/leverage.md
    - Liquidations: crvusd/liquidations.md
    - How to Borrow & Use Leverage: lending/how-to-borrow.md
    - How to Supply: lending/how-to-supply.md
    - Lending FAQ: lending/faq.md
    - How to Create a Lending Market: lending/create-lending-market.md
  - Pools:
    - Overview: pools/overview.md
    - Deposit FAQ: pools/deposit-faqs.md
    - Depositing into a Stableswap Pool: pools/depositing-into-a-stableswap-pool.md
    - Depositing into a Cryptoswap Pool: pools/depositing-into-a-cryptoswap-pool.md
    - Calculating yield: pools/calculating-yield.md
    - Charts and Pool Activity: pools/charts_poolactivity.md
  - Pool Creation:
    - Pool Creation Overview: pool-creation/pool-creation-overview.md
    - Creating a Stableswap Pool: pool-creation/creating-a-stableswap-pool.md
    - Creating a Cryptoswap Pool: pool-creation/creating-a-cryptoswap-pool.md
    - Understanding Oracles: pool-creation/understanding-oracles.md
  - Reward Gauges:
    - Overview: reward-gauges/overview.md
    - Creating a pool gauge: reward-gauges/creating-a-pool-gauge.md
    - Boosting your CRV rewards: reward-gauges/boosting-your-crv-rewards.md
    - Gauge weights: reward-gauges/gauge-weights.md
    - Permissionless rewards: reward-gauges/permissionless-rewards.md
  - Governance:
    - Understanding Governance: governance/understanding-governance.md
    - Voting: governance/voting.md
    - Community Fund: governance/community-fund.md
    - Proposals:
      - Creating a DAO proposal: governance/proposals/creating-a-dao-proposal.md
  - Cross-Chain:
    - Overview: cross-chain/overview.md
    - DEX & Llamalend: cross-chain/dex-llamalend.md
    - Curve Assets (CRV, crvUSD, scrvUSD): cross-chain/curve-assets.md
    - How to Bridge Curve Assets to L1s: cross-chain/bridging-curve-eco-tokens.md
  - Support & Troubleshooting:
    - Support: troubleshooting/support.md
    - Recovering cross-asset swaps: troubleshooting/recovering-a-cross-asset-swap.md
    - Dropping and replacing a stuck transaction: troubleshooting/dropping-and-replacing-a-stuck-transaction.md
    - Disabling crypto wallets in brave: troubleshooting/disabling-crypto-wallets-in-brave.md
  - Risks, Security & Audits: 
    - Risks: 
      - Liquidity Pools: risks-security/risks/pool.md
      - Lending: risks-security/risks/lending.md
      - crvUSD: risks-security/risks/crvusd.md
      - scrvUSD: risks-security/risks/scrvusd.md
    - Security & Audits: risks-security/security.md
  - Whitepapers:
    - Curve Stableswap (2019): pdf/curve-stableswap.pdf
    - Curve DAO (2020): pdf/curve-dao.pdf
    - Curve Cryptopools (2021): pdf/curve-cryptopools.pdf
    - Curve Stablecoin (2022): pdf/curve-stablecoin.pdf
  - Links:
    - Curve.fi: https://curve.fi/#/ethereum/swap
    - Curve DAO: https://curve.fi/dao
    - Curve News: https://news.curve.fi/
    - Discord: https://discord.gg/twUngQYz85
    - Github: https://github.com/curvefi/
    - Governance Forum: https://gov.curve.fi/
    - Twitter: https://twitter.com/curvefinance
    - Technical Docs: https://docs.curve.fi/
    - Telegram: https://t.me/curvefi
    - Curve Monitor: https://curvemonitor.com/
    - crvhub: https://crvhub.com/
  - Glossary: glossary-branding/glossary.md
  - Branding & Icons: glossary-branding/branding.md