semantica/mkdocs.yml

site_name: Semantica
site_description: Open Source Framework for Semantic Intelligence & Knowledge Engineering
site_url: https://semantica.dev
repo_url: https://github.com/Hawksight-AI/semantica
repo_name: Hawksight-AI/semantica
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2024 Hawksight AI

# Theme Configuration
theme:
  name: material
  palette:
    # Light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.tracking
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tooltips
  icon:
    logo: material/brain
    repo: fontawesome/brands/github

# Extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

# Plugins
plugins:
  - search:
      lang: en
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_category_heading: true
  - mkdocs-jupyter:
      include_source: true

# Custom CSS
extra_css:
  - css/custom.css

# Navigation
nav:
  - Home: index.md
  - Getting Started:
    - getting-started.md
    - installation.md
    - quickstart.md
  - Guides:
    - concepts.md
    - modules.md
    - use-cases.md
    - examples.md
    - learning-more.md
  - Cookbook:
    - Introduction:
      - cookbook/introduction/Welcome_to_Semantica.ipynb
      - cookbook/introduction/Configuration_Basics.ipynb
      - cookbook/introduction/Your_First_Knowledge_Graph.ipynb
      - cookbook/introduction/Data_Ingestion.ipynb
      - cookbook/introduction/Document_Parsing.ipynb
      - cookbook/introduction/Data_Normalization.ipynb
      - cookbook/introduction/Entity_Extraction.ipynb
      - cookbook/introduction/Relation_Extraction.ipynb
      - cookbook/introduction/Embedding_Generation.ipynb
      - cookbook/introduction/Vector_Store.ipynb
      - cookbook/introduction/Ontology.ipynb
      - cookbook/introduction/Conflict_Detection.ipynb
      - cookbook/introduction/Deduplication.ipynb
      - cookbook/introduction/Building_Knowledge_Graphs.ipynb
      - cookbook/introduction/Graph_Analytics.ipynb
      - cookbook/introduction/Graph_Quality.ipynb
      - cookbook/introduction/Visualization.ipynb
      - cookbook/introduction/Export.ipynb
  - Reference:
    - Core: reference/core.md
    - Ingest: reference/ingest.md
    - Parse: reference/parse.md
    - Normalize: reference/normalize.md
    - Semantic Extract: reference/semantic_extract.md
    - Knowledge Graph: reference/kg.md
    - Embeddings: reference/embeddings.md
    - Vector Store: reference/vector_store.md
    - Triple Store: reference/triple_store.md
    - Ontology: reference/ontology.md
    - Reasoning: reference/reasoning.md
    - Pipeline: reference/pipeline.md
    - Export: reference/export.md
    - Visualization: reference/visualization.md
    - Utils: reference/utils.md
  - Resources:
    - community-projects.md
    - citation.md
    - faq.md
    - license.md

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Hawksight-AI/semantica
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/semantica/
  version:
    provider: mike