mkdocs.yml

# Project information
site_name: ECUtils
site_url: https://ecutils.readthedocs.io/en/stable/
site_author: Isak Ruas
site_description: >-
  A comprehensive Python library for elliptic curve operations, providing utilities
  for common tasks such as digital signature generation and verification (ECDSA),
  key exchange protocols (ECDH and Massey-Omura), message encoding onto elliptic
  curves (Koblitz) as well as various elliptic curve operations. It is designed to be
  easy-to-use for cryptographic purposes and to facilitate the harnessing of
  elliptic curve cryptography for security applications.

# Repository
repo_name: isakruas/ecutils
repo_url: https://github.com/isakruas/ecutils

# Copyright
copyright: Copyright &copy; 2022-2024 <a href="https://lattes.cnpq.br/4397351570177069" target="_blank">Ruas, Isak Paulo de Andrade</a>; <a href="https://lattes.cnpq.br/0567547569121826" target="_blank">Paiva, Celimar Reijane Alves Damasceno</a>; <a href="https://lattes.cnpq.br/7059909954060830" target="_blank">Silva, Fernando Marcos Souza</a>.

# Configuration
theme:
  name: material
  language: en
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  font:
    text: Roboto
    code: Roboto Mono

# Plugins
plugins:
  - search
  - minify:
      minify_html: true

# Page tree
nav:
  - Home: index.md
  - Installation: installation.md
  - Usage: usage.md
  - Core:
      - Point: core/point.md
      - Elliptic Curve: core/elliptic_curve.md
  - Algorithms:
      - Koblitz: algorithms/koblitz.md
      - Digital Signature: algorithms/digital_signature.md
  - Protocols:
      - Diffie-Hellman: protocols/diffie_hellman.md
      - Massey-Omura: protocols/massey_omura.md
  - Reference:
      - Curves: reference/curves.md