Files
semantica/mkdocs.yml
T

166 lines
4.0 KiB
YAML

# Deployment Trigger: Public GitHub Pages
site_name: Semantica
site_description: Open Source Framework for Semantic Intelligence & Knowledge Engineering
site_url: https://hawksight-ai.github.io/semantica/
repo_url: https://github.com/Hawksight-AI/semantica
repo_name: Hawksight-AI/semantica
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright © 2026 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:
base_path: ["."]
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.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
toc_depth: 6
# 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
# Custom JavaScript
extra_javascript:
- js/version-selector.js
# Navigation
nav:
- Home: index.md
- Getting Started:
- Overview: getting-started.md
- installation.md
- quickstart.md
- Docs:
- Conflicts: reference/conflicts.md
- Context: reference/context.md
- Core: reference/core.md
- Deduplication: reference/deduplication.md
- Embeddings: reference/embeddings.md
- Evals: reference/evals.md
- Export: reference/export.md
- Graph Store: reference/graph_store.md
- Ingest: reference/ingest.md
- Knowledge Graph: reference/kg.md
- LLMs: reference/llms.md
- Normalize: reference/normalize.md
- Ontology: reference/ontology.md
- Parse: reference/parse.md
- Pipeline: reference/pipeline.md
- Reasoning: reference/reasoning.md
- Seed: reference/seed.md
- Semantic Extract: reference/semantic_extract.md
- Split: reference/split.md
- Triplet Store: reference/triplet_store.md
- Utils: reference/utils.md
- Vector Store: reference/vector_store.md
- Visualization: reference/visualization.md
- Guides:
- concepts.md
- deep-dive.md
- modules.md
- glossary.md
- use-cases.md
- examples.md
- Code Examples: CodeExamples.md
- learning-more.md
- Cookbook: cookbook.md
- Resources:
- community-projects.md
- community.md
- contributing.md
- architecture.md
- governance.md
- citation.md
- Changelog: changelog.md
- Release Guide: release-guide.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
generator: true