mkdocs.yml

# Project Information
site_name: FAIRSCAPE CLI
site_description: A utility for packaging objects and validating metadata for FAIRSCAPE.
site_url: https://github.com/fairscape/fairscape-cli

# Repository
repo_name: fairscape/fairscape-cli
repo_url: https://github.com/fairscape/fairscape-cli

# Copyright
copyright: Copyright © 2023 THE RECTOR AND VISITORS OF THE UNIVERSITY OF VIRGINIA

# Page tree
nav:
  - Home: index.md
  - Setup: setup.md
  - Examples:
      - Complete Demo: workflows/complete-demo.md
  - Commands:
      - RO-Crate: commands/rocrate.md
      - Schema: commands/schema.md
      - Import: commands/import.md
      - Build: commands/build.md
      - Publishing: commands/publish.md
  - Properties:
      - Datasheet Properties: datasheet-properties.md
      - AI-Ready Scoring: ai-ready-scoring.md

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - content.tabs.link
  palette:
    - scheme: default
      primary: indigo
      accent: indigo

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/fairscape/fairscape-cli