zettelforge/mkdocs.yml at master · rolandpg/zettelforge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
site_name: ZettelForge Documentation
site_url: https://docs.threatrecall.ai/
site_description: "ZettelForge — agentic memory for Python agents with CTI entity extraction, STIX knowledge graphs, threat-actor alias resolution, and an MCP server. Offline-first, MIT-licensed."
site_author: Patrick Roland
repo_url: https://github.com/rolandpg/zettelforge
repo_name: rolandpg/zettelforge

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    scheme: slate
    primary: custom
    accent: custom
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.highlight
    - content.code.copy
  logo: assets/logo.svg
  favicon: assets/favicon.svg

plugins:
  - search
  - meta

extra:
  # Sourced by docs/overrides/main.html for JSON-LD SoftwareApplication.
  # Bump on each release so schema.org metadata stays in sync with PyPI.
  version: "2.4.0"

extra_css:
  # Brand tokens first — defines --signal-*, --graphite-*, --fog-*, --font-*
  # that extra.css maps into mkdocs-material's --md-* variables below.
  # This is the :root-only subset of docs/brand/colors_and_type.css; the
  # full canonical file (with semantic type roles) is kept as a reference
  # but not loaded into mkdocs because its html/body/h1-h4 rules would
  # fight mkdocs-material's theme.
  - stylesheets/brand-tokens.css
  - stylesheets/extra.css

extra_javascript:
  - assets/cf-analytics.js

nav:
  - Home: index.md
  - Getting Started:
    - Quickstart: tutorials/01-quickstart.md
    - First CTI Report: tutorials/02-first-cti-report.md
  - How-To Guides:
    - Build Extensions: how-to/build-extensions.md
    - Configure LanceDB: how-to/configure-lancedb.md
    - Configure OpenCTI: how-to/configure-opencti.md
    - Configure Sigma Ingestion: how-to/configure-sigma-ingestion.md
    - Configure TypeDB: how-to/configure-typedb.md
    - Configure YARA Ingestion: how-to/configure-yara-ingestion.md
    - Ingest News Report: how-to/ingest-news-report.md
    - Integrate LLM Agent: how-to/integrate-llm-agent.md
    - Integrate with CrewAI: how-to/integrate-with-crewai.md
    - Integrate with LangChain: how-to/integrate-with-langchain.md
    - Maintain LanceDB: how-to/maintain-lancedb.md
    - Migrate JSONL to SQLite: how-to/migrate-jsonl-to-sqlite.md
    - Query APT Tools: how-to/query-apt-tools.md
    - Reproduce Benchmarks: how-to/reproduce-benchmarks.md
    - Resolve Aliases: how-to/resolve-aliases.md
    - Run Temporal Query: how-to/run-temporal-query.md
    - Set Up MCP Server: how-to/set-up-mcp-server.md
    - Store Threat Actor: how-to/store-threat-actor.md
    - Troubleshoot: how-to/troubleshoot.md
    - Upgrade: how-to/upgrade.md
    - Use Detection Rules: how-to/use-detection-rules.md
  - Concepts:
    - Architecture: explanation/architecture.md
    - Two-Phase Pipeline: explanation/two-phase-pipeline.md
    - STIX in ZettelForge: explanation/stix-in-zettelforge.md
    - Epistemic Tiers: explanation/epistemic-tiers.md
    - LLM Budgets & Timeouts: explanation/llm-budgets-and-timeouts.md
    - Zettelkasten Philosophy: explanation/zettelkasten-philosophy.md
  - Reference:
    - Architecture Deep Dive: reference/architecture-deep-dive.md
    - Configuration: reference/configuration.md
    - Detection Rules Schema: reference/detection-rules-schema.md
    - Editions: reference/editions.md
    - Entity Indexer Concurrency: reference/entity-indexer-concurrency.md
    - Governance Controls: reference/governance-controls.md
    - KG Edge Schema: reference/kg-edge-schema.md
    - MCP Protocol: reference/mcp-protocol.md
    - Memory Manager API: reference/memory-manager-api.md
    - Module Inventory: reference/module-inventory.md
    - Retrieval Policies: reference/retrieval-policies.md
    - Sigma Schema Reference: reference/sigma-schema-reference.md
    - STIX Schema: reference/stix-schema.md
    - Web API Reference: reference/web-api.md
    - YARA Schema Reference: reference/yara-schema-reference.md
  - Design:
    - Brand Identity: brand/brandIdentity.md
    - RFC-001 Conversational Entity Extractor: rfcs/RFC-001-conversational-entity-extractor.md
    - RFC-002 Universal LLM Provider Interface: rfcs/RFC-002-universal-llm-provider.md
    - RFC-003 Read-Path Depth Routing: rfcs/RFC-003-read-path-depth-routing.md
  - About:
    - Why ZettelForge: narrative/2026-04-16-the-memory-problem.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true