# MkDocs configuration for readur.app documentation site_name: Readur Documentation site_url: https://readur.app site_description: Intelligent Document Management System with OCR - Transform your documents into a searchable knowledge base site_author: Readur Team # Repository information (optional, adds edit links) repo_name: readur/readur repo_url: https://github.com/readur/readur edit_uri: edit/main/docs/ # Copyright copyright: Copyright © 2025 Readur # Theme configuration theme: name: material # Color scheme palette: # Light mode - media: "(prefers-color-scheme: light)" scheme: default primary: teal accent: light-blue toggle: icon: material/brightness-7 name: Switch to dark mode # Dark mode - warmer, less depressing colors - media: "(prefers-color-scheme: dark)" scheme: slate primary: blue-grey accent: light-blue toggle: icon: material/brightness-4 name: Switch to light mode # Font configuration - more readable, friendly fonts font: text: Inter code: JetBrains Mono # Features features: - announce.dismiss - content.action.edit - content.action.view - content.code.annotate - content.code.copy - content.tooltips - navigation.footer - navigation.indexes - navigation.instant - navigation.instant.prefetch - navigation.instant.progress - navigation.path - navigation.prune - navigation.sections - navigation.tabs - navigation.tabs.sticky - navigation.top - navigation.tracking - search.highlight - search.share - search.suggest - toc.follow - toc.integrate # Icons icon: logo: material/book-open-page-variant repo: fontawesome/brands/github # Plugins plugins: - search: separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' lang: - en - minify: minify_html: true minify_js: true minify_css: true htmlmin_opts: remove_comments: true - git-revision-date-localized: enable_creation_date: true type: iso_datetime fallback_to_build_date: true # Extensions markdown_extensions: # Python Markdown - abbr - admonition - attr_list - def_list - footnotes - md_in_html - toc: permalink: true permalink_title: Anchor link to this section for reference # 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: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.keys - pymdownx.mark - pymdownx.smartsymbols - pymdownx.snippets - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true combine_header_slug: true - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde # Extra CSS and JavaScript extra_css: - stylesheets/extra.css extra_javascript: - javascripts/extra.js # MathJax for mathematical notation (optional) - javascripts/mathjax.js - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js # Extra configuration extra: # Social links social: - icon: fontawesome/brands/github link: https://github.com/readur/readur - icon: fontawesome/brands/twitter link: https://twitter.com/readur - icon: fontawesome/brands/discord link: https://discord.gg/readur # Analytics (optional) analytics: provider: google property: G-XXXXXXXXXX # Replace with your Google Analytics ID feedback: title: Was this page helpful? ratings: - icon: material/emoticon-happy-outline name: This page was helpful data: 1 note: >- Thanks for your feedback! - icon: material/emoticon-sad-outline name: This page could be improved data: 0 note: >- Thanks for your feedback! Help us improve this page by opening an issue. # Versioning (optional) version: provider: mike default: stable # Cookie consent (optional) consent: title: Cookie consent description: >- We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. # Navigation structure nav: - Home: index.md - Quick Start: - Self-Hosting: quickstart/self-hosting.md - Docker Setup: quickstart/docker.md - Development: quickstart/development.md - Self-Hosting: - Overview: self-hosting/index.md - Installation: - getting-started/installation.md - deployment.md - Configuration: - getting-started/configuration.md - configuration-reference.md - Storage Setup: - s3-storage-guide.md - WATCH_FOLDER.md - per-user-watch-directories.md - Authentication: - oidc-setup.md - user-management-guide.md - Networking: - REVERSE_PROXY.md - Backup & Updates: - backup-recovery.md - migration-guide.md - administration/storage-migration.md - Security: - security-guide.md - Using Readur: - Getting Started: guide/overview.md - Complete Guide: user-guide.md - Gallery: gallery.md - Documents & OCR: - file-upload-guide.md - multi-language-ocr-guide.md - Search & Organization: - advanced-search.md - labels-and-organization.md - Sources & Sync: sources-guide.md - Analytics: analytics-dashboard-guide.md - Notifications: notifications-guide.md - Administration: - Health Monitoring: health-monitoring-guide.md - Performance Tuning: performance-tuning.md - CLI Tools: administration/cli-tools.md - Troubleshooting: - troubleshooting.md - s3-troubleshooting.md - administration/migration-troubleshooting.md - API & Integrations: - API Reference: api-reference.md - Integration Guide: integrations.md - Swagger UI: swagger-ui-guide.md - Reference: - Architecture: architecture.md - Configuration: configuration-reference.md - CLI Reference: administration/cli-tools.md - Development: - Contributing: dev/README.md - Development Setup: dev/development.md - Testing: - dev/TESTING.md - dev/README-E2E.md - dev/test-infrastructure.md - dev/LABEL_TESTING.md - Architecture: - dev/architecture.md - dev/QUEUE_IMPROVEMENTS.md - dev/DATABASE_GUARDRAILS.md - Optimization: - dev/OCR_OPTIMIZATION_GUIDE.md - dev/ERROR_SYSTEM.md