monero-docs/mkdocs.yml

# Project information
site_name: Monero Docs
site_description: 'Monero Documentation'
site_author: "Monero Community"
site_url: 'https://docs.getmonero.org'
site_dir: 'public'

copyright: '© 2024 Monero Community under <a href="https://opensource.org/licenses/MIT">MIT</a>'

nav:
- Home: 'index.md'
- Interacting:
  - The Basics:
    - Overview: 'interacting/overview.md'
    - Tokenomics: 'technical-specs.md'
    - Networks: 'infrastructure/networks.md'
  - Download & Verify:
    - Download: 'interacting/download-monero-binaries.md'
    - Verify: 'interacting/verify-monero-binaries.md'
  - Monerod:
    - Flags: 'interacting/monerod-reference.md'
    - Setup Guide:
#      - I2P: 'running-node/open-node-tor-onion.md' TODO
      - Tor: 'running-node/open-node-tor-onion.md'
    - Sample Configs:
      - VPS: 'interacting/monero-config-file.md'
#      - Home: 'interacting/moneord-tori2p.md' # TODO
  - Wallets:
    - monero-wallet-gui: 'interacting/monero-wallet-gui-reference.md'
    - monero-wallet-cli: 'interacting/monero-wallet-cli-reference.md'
    - monero-wallet-rpc: 'interacting/monero-wallet-rpc-reference.md'
    - Advanced Transactions:
      - Multisignature: 'multisignature.md'
      - Offline Transaction Signing: 'cold-storage/offline-transaction-signing.md'
  - Blockchain Tools:
    - monero-blockchain-export: 'interacting/monero-blockchain-export-reference.md'
    - monero-blockchain-import: 'interacting/monero-blockchain-import-reference.md'
  - External:
    - MoneroPulse: 'infrastructure/monero-pulse.md'
- RPC Library:
  - Node RPC: 'rpc-library/monerod-rpc.md'
  - Wallet RPC: 'rpc-library/wallet-rpc.md'
- R&D:
  - Cryptography:
    - Introduction: 'cryptography/introduction.md'
    - Asymmetric: # Needs clarity
      - Introduction: 'cryptography/asymmetric/introduction.md'
      - Private keys: 'cryptography/asymmetric/private-key.md'
      - Public keys: 'cryptography/asymmetric/public-key.md'
      - Edwards25519 curve: 'cryptography/asymmetric/edwards25519.md'
      - Key image: 'cryptography/asymmetric/key-image.md'
    - Base58: 'cryptography/base58.md'
    - Keccak-256: 'cryptography/keccak-256.md'
    - PRNG: 'cryptography/prng.md'
  - Address Types:
    - Standard: 'public-address/standard-address.md'
    - Subaddress: 'public-address/subaddress.md'
    - Integrated: 'public-address/integrated-address.md'
  - Proof of Work: # This section needs improvement
    - What is PoW?: 'proof-of-work/what-is-pow.md'
    - PoW in Cryptocurrencies: 'proof-of-work/pow-in-cryptocurrencies.md'
    - CryptoNight: 'proof-of-work/cryptonight.md'
    - RandomX: 'proof-of-work/random-x.md'
#- Accepting Monero:
#    - Overview: 'accepting-monero/overview.md'


theme:
  name: material
  custom_dir: overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep-orange
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep-orange
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  favicon: images/favicon.ico
  icon:
    logo: logo
  logo: 'images/monero.svg'
  static_templates:
    - 404.html

extra_css:
  - overrides.css

extra:
  social:
    - icon: material/web
      link: https://docs.getmonero.org
      name: Clearnet Website
    - icon: simple/torbrowser
      link: http://xmrdoc6phnvjbf5hmjbwdfu47zavzfngymlnwhs2gyxxpxmad4c65kyd.onion
      name: Tor Onion
    - icon: custom/i2p
      link: http://xmrdoc6k4licya7zsnba5s7vugzo72blcpukkvqno75o4ruhaqla.b32.i2p
      name: I2P Eepsite
    - icon: fontawesome/brands/github
      link: https://github.com/monero-project/monero-docs
      name: GitHub Repository
    - icon: simple/matrix
      link: https://matrix.to/#/%23monero-docs:monero.social
      name: Matrix
    - icon: simple/liberadotchat
      link: https://web.libera.chat/#monero-docs
      name: IRC via Libera.chat

repo_name: 'monero-project/monero-docs'
repo_url: 'https://github.com/monero-project/monero-docs'
# todo: change to master branch
edit_uri: blob/test/docs/

markdown_extensions:
  # https://squidfunk.github.io/mkdocs-material/extensions/admonition/
  - admonition
  - abbr
  - def_list
  - attr_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true         # build time highlighting, not client side
  - pymdownx.inlinehilite
  - pymdownx.superfences         # nest code blocks inside codeblocks
  - pymdownx.snippets            # insert content from other files
  - tables

plugins:
  - search
  - minify:
      minify_html: true
      minify_js: true
      htmlmin_opts:
        remove_comments: true
  - privacy
  - macros:
      include_dir: docs/macros/includes
      include_yaml:
        - docs/macros/monerod.yml
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: fr
          name: Français
          build: false
        - locale: es
          name: Español
          build: false
        - locale: it
          name: Italiano
          build: false
        - locale: pl
          name: Polski
          build: false
        - locale: ar
          name: العربية
          build: false
        - locale: ru
          name: Русский
          build: false
        - locale: de
          name: Deutsch
          build: false
        - locale: nl
          name: Nederlands
          build: false
        - locale: pt
          name: Português
          build: false
        - locale: tr
          name: Türkçe
          build: false
        - locale: zh
          name: 中文 (简体)
          build: false
        - locale: zh-TW
          name: 中文 (繁體)
          build: false
        - locale: nb
          name: Norsk Bokmål
          build: false