openaleph.org/mkdocs.yml at main · openaleph/openaleph.org · 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
119
120
site_name: OpenAleph
site_url: https://openaleph.org
site_description: OpenAleph – The open source platform to search documents and structured data for investigative newsrooms and research organizations. Originally started by OCCRP as "Aleph" and now developed by the Data and Research Center – DARC

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/openaleph-logo.svg
  favicon: assets/favicon.png
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - toc.follow
    # - content.code.copy
    - header.autohide
  palette:
    scheme: default
  icon:
    menu: material/menu
    search: material/magnify

extra:
  logo_light: assets/openaleph-logo.svg
  # Header breadcrumb root, shown before the page title ("openaleph.org  About").
  # Falls back to the site_url domain when unset; pinned here so `mkdocs serve`
  # (which rewrites site_url to the dev address) still shows the real domain.
  domain: openaleph.org
  social:
    - icon: material/mail
      link: mailto:hi@dataresearchcenter.org
    - icon: material/web
      link: https://dataresearchcenter.org
    - icon: material/linkedin
      link: https://www.linkedin.com/company/dataresearchcenter/
    - icon: material/github
      link: https://github.com/openaleph

extra_css:
  - https://dataresearchcenter.github.io/zensical-theme-darc/stylesheets/darc-zensical.css
  - stylesheets/tokens.css
  - stylesheets/components.css
  - stylesheets/site.css
  - stylesheets/extra.css

extra_javascript:
  - javascripts/scroll-color.js

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  # String references resolve to Zensical's bundled icon-aware
  # to_svg/twemoji helpers (zensical/config.py:453-457) – these scan
  # `templates/.icons/{lucide,material,simple,octicons,fontawesome}/`
  # so `:lucide-x:` / `:material-x:` / `:simple-x:` / `:octicons-x:` /
  # `:fontawesome-...:` shortcodes render as inline SVG.
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - meta
  - blog:
      post_url_date_format: yyyy
      blog_toc: false
      post_excerpt: required
  - search
  # `cache: false` is deliberate: with a warm cache the optimize plugin's
  # worker rewrites a file's src_path to its .cache path before the main
  # thread removes it from the Files collection, intermittently crashing the
  # build ("... not in collection"). Disabling the cache keeps every job doing
  # real (slower) work, so removal always wins the race.
  - optimize:
      cache: false
      enabled: !ENV [CI, false]
  # Map legacy (pre-migration) blog URLs → the new blog-plugin posts.
  # Values are the post src paths; the redirects plugin resolves each to the
  # post's current URL. Generated by build.py (rerun it if articles change).
  - redirects:
      redirect_maps:
        "blog/2026/04/OpenAleph-5.2.1:-Taking-Translations-a-Step-Further/a9e1585c-3c3d-43b3-9319-021dc76e908f.md": "blog/posts/2026-04-08-openaleph-5-2-1-taking-translations-a-step-further.md"
        "blog/2026/03/In-Platform-Translation-for-Sensitive-Documents/38401cf3-2455-4b0f-a8ea-95e38b97b2f2.md": "blog/posts/2026-03-09-in-platform-translation-for-sensitive-documents.md"
        "blog/2026/03/When-Emails-Get-Complicated:-5.2-Handles-It/64dac929-6e82-493e-af84-c0afc8783239.md": "blog/posts/2026-03-09-when-emails-get-complicated-5-2-handles-it.md"
        "blog/2026/03/OpenAleph-5.2:-Strengthening-Email-and-Breaking-Language-Barriers/a1df2376-0bda-44a8-9cf3-ccc4d8534c54.md": "blog/posts/2026-03-09-openaleph-5-2-strengthening-email-and-breaking-language-barriers.md"
        "blog/2025/12/OpenAleph-5.1-Released:-Reworked-Synonym-Search-and-New-Tagging-Feature/ea154c56-220f-48f6-a1c1-deb9c745f574.md": "blog/posts/2025-12-19-openaleph-5-1-released-reworked-synonym-search-and-new-tagging-feature.md"
        "blog/2025/09/A-Look-Inside-OpenAleph-5s-ElasticSearch-Improvements/412bfb6e-63ec-4d84-80f5-a1a3ace91520.md": "blog/posts/2025-09-05-a-look-inside-openaleph-5s-elasticsearch-improvements.md"
        "blog/2025/09/When-Names-Travel-Together:-Discover-Correlations-in-Your-Data/86038fe7-a661-4eeb-a274-82321e156caa.md": "blog/posts/2025-09-03-when-names-travel-together-discover-correlations-in-your-data.md"
        "blog/2025/09/80-Years-of-The-Aleph-and-the-release-of-OpenAleph-5/2ac021f4-ad09-47ff-a9f0-5f96aa512753.md": "blog/posts/2025-09-01-80-years-of-the-aleph-and-the-release-of-openaleph-5.md"
        "blog/2025/08/Bringing-Local-AI-to-OpenAleph/d6074b8f-3d19-43b8-89c2-0c87bfb98591.md": "blog/posts/2025-08-22-bringing-local-ai-to-openaleph.md"
        "blog/2025/06/Geocoded-Addresses-in-OpenAleph:-A-New-Way-to-Spot-Connections/896ad56e-f96c-41dd-a676-dcb0e705201b.md": "blog/posts/2025-06-24-geocoded-addresses-in-openaleph-a-new-way-to-spot-connections.md"
        "blog/2025/05/Putting-a-Face-to-the-Name/c003a3a8-ce3d-4745-b61c-ed52e3898525.md": "blog/posts/2025-05-28-putting-a-face-to-the-name.md"
        "blog/2025/05/Making-Audio-and-Video-Files-Searchable/999f0117-7cf3-4099-bcd9-f60f5492c897.md": "blog/posts/2025-05-22-making-audio-and-video-files-searchable.md"
        "blog/2025/05/AI-Transcriptions-in-OpenAleph:-the-First-Steps/68450c9c-78e7-4e3f-8743-40ad6ba7b4f9.md": "blog/posts/2025-05-22-ai-transcriptions-in-openaleph-the-first-steps.md"
        "blog/2025/05/A-Fresh-Take-on-File-Ingestion-and-Python-Integration-for-OpenAleph/0802565a-4279-4d6f-84f6-4ab2b09f38f1.md": "blog/posts/2025-05-15-a-fresh-take-on-file-ingestion-and-python-integration-for-openaleph.md"
        "blog/2025/03/OpenAleph-commits-to-the-commons/3510138e-16b3-4b5d-a06c-41af0aa2d517.md": "blog/posts/2025-03-31-openaleph-commits-to-the-commons.md"

# Homepage is the landing page (reached via the logo) — keep it out of the nav.
not_in_nav: |
  index.md

nav:
  - Get Started: start.md
  - News: blog/index.md
  - Managed Servers: managed.md
  - FAQ: faq.md
  - About: about.md