presidio/mkdocs.yml

site_name: Microsoft Presidio
site_url: https://microsoft.github.io/presidio
site_description: PII anonymization for text and images.
site_author: Microsoft

repo_url: https://github.com/microsoft/presidio/
edit_uri: ""

nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: getting_started.md
  - Handling text: 
    - Home: text_anonymization.md
    - Step by step tutorial: 
      - Home: tutorial/index.md
      - Getting started: tutorial/00_getting_started.md
      - Deny-list recognizers: tutorial/01_deny_list.md
      - Regex recognizers: tutorial/02_regex.md
      - Rule-based recognizers: tutorial/03_rule_based.md
      - Additional models/languages: tutorial/05_languages.md
      - External services: tutorial/04_external_services.md
      - Context enhancement: tutorial/06_context.md
      - Decision process: tutorial/07_decision_process.md
      - No-code recognizers: tutorial/08_no_code.md
      - Ad-hoc recognizers: tutorial/09_ad_hoc.md
      - Simple anonymization: tutorial/10_simple_anonymization.md
      - Custom anonymization: tutorial/11_custom_anonymization.md
      - Encryption/Decryption: tutorial/12_encryption.md
      - Allow-lists: tutorial/13_allow_list.md

    - Presidio Analyzer:
      - Home: analyzer/index.md
      - Developing PII recognizers:
        - Tutorial: analyzer/adding_recognizers.md
        - Best practices in developing recognizers: analyzer/developing_recognizers.md
        - Customizing recognizer registry from file: analyzer/recognizer_registry_provider.md
      - Multi-language support: analyzer/languages.md
      - Customizing the NLP model: 
        - Home: analyzer/customizing_nlp_models.md
        - Spacy/Stanza: analyzer/nlp_engines/spacy_stanza.md
        - Transformers: analyzer/nlp_engines/transformers.md
      - Tracing the decision process: analyzer/decision_process.md
      - Configuring the Analyzer Engine from file: analyzer/analyzer_engine_provider.md
    - Presidio Anonymizer:
      - Home: anonymizer/index.md
      - Developing PII operators: anonymizer/adding_operators.md
  - Handling images: 
    - Home: image-redactor/index.md
    - Evaluating DICOM redaction: image-redactor/evaluating_dicom_redaction.md
  - Handling structured data:
    - Home: structured/index.md
  - Samples: 
    - Home: samples/index.md  
    - Selected samples:
      - Customizing Presidio Analyzer: samples/python/customizing_presidio_analyzer.ipynb
      - NER model configuration: samples/python/ner_model_configuration.ipynb
      - Presidio Structured Basic Usage: samples/python/example_structured.ipynb
      - Using an allow list with image redaction: samples/python/image_redaction_allow_list_approach.ipynb
      - Redacting Text PII from DICOM images: samples/python/example_dicom_image_redactor.ipynb
      - Annotating PII in a PDF: samples/python/example_pdf_annotation.ipynb
      - Pseudonomization: samples/python/pseudonomyzation.ipynb
      - Encrypting and Decrypting: samples/python/encrypt_decrypt.ipynb

  - General:
    - Supported entities: supported_entities.md
    - Development and design:
      - Design: design.md
      - Setting up a development environment: development.md
      - Build and release process: build_release.md
      - Changes from V1 to V2: presidio_V2.md
      - Python API reference:
        - Home: api.md
        - Presidio Analyzer Python API: api/analyzer_python.md
        - Presidio Anonymizer Python API: api/anonymizer_python.md
        - Presidio Image Redactor Python API: api/image_redactor_python.md
      - REST API reference: https://microsoft.github.io/presidio/api-docs/api-docs.html" target="_blank

    - Community: community.md
    - FAQ: faq.md
    - Demo: https://huggingface.co/spaces/presidio/presidio_demo" target="_blank
theme:
  name: material
  custom_dir: overrides
  palette:
      scheme: default
      primary: blue grey
      accent: indigo
  font:
    text: Roboto
    code: Roboto Mono
  hide:
    - toc
  logo: assets/ms_icon.png
  favicon: assets/ms_icon.png
  features:
    - navigation.instant
    - content.tabs.link
    # - navigation.sections
    # - navigation.tabs
    # - navigation.tabs.sticky
plugins:
- search
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: sphinx
- mkdocs-jupyter:
    ignore_h1_titles: True

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/microsoft/presidio
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/_/microsoft-presidio
    - icon: fontawesome/solid/envelope
      link: mailto:presidio@microsoft.com

markdown_extensions:
  - meta
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.pathconverter
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format