mkdocs.yml

site_name: Recon
site_description: Debug annotated Named Entity Recognition (NER) data for inconsitencies and get insights on improving the quality of your data.
site_url: https://kabirkhan.github.io/recon/

theme:
    name: 'material'
    palette:
        primary: 'white'
        accent: 'purple'
    icon:
        repo: 'fontawesome/brands/github-alt'
    logo: 'img/recon.svg'
    favicon: 'img/recon.svg'
    custom_dir: docs/overrides

repo_name: 'kabirkhan/recon'
repo_url: 'https://github.com/kabirkhan/recon'
edit_uri: 'https://github.com/kabirkhan/recon/tree/master/docs'

nav:
    - Recon: 'index.md'
    - Tutorial:
        - Loading Data: 'tutorial/loading_data.md'
        - NER Stats: 'tutorial/ner_stats.md'
        - Dataset:
            - Dataset Intro: 'tutorial/dataset_intro.md'
            - Making changes to a Dataset: 'tutorial/dataset_mutate.md'
        - Using a Corpus: 'tutorial/corpus.md'
        - Fixing Conll 2003:
            - Loading Data: 'tutorial/conll/loading.md'
            - Advanced Stats: 'tutorial/conll/stats.md'
            - Insights:
                - Label Disparities: 'tutorial/conll/label_insights.md'
                - Model Based Insights: 'tutorial/conll/model_insights.md'
        # - More NER Stats: 'tutorial/4_more_stats.md'
        # - Getting Insights: 'tutorial/5_getting_insights.md'
        - Custom EntityRecognizer: 'tutorial/custom_entity_recognizer.md'
    - API Reference:
        - Corpus: 'api/corpus.md'
        - Corrections: 'api/corrections.md'
        - Dataset: 'api/dataset.md'
        - Hashing: 'api/hashing.md'
        - Insights: 'api/insights.md'
        - Loaders: 'api/loaders.md'
        - Operations: 'api/operations.md'
        - Stats: 'api/stats.md'
        - Store: 'api/store.md'
        - Tokenization: 'api/tokenization.md'
        - Validation: 'api/validation.md'
        - Recognizers:
            - EntityRecognizer: 'api/recognizers/base.md'
            - SpacyEntityRecognizer: 'api/recognizers/spacy.md'
        - Types: 'api/types/example.md'
    - Release Notes: release-notes.md

markdown_extensions:
    - toc:
        permalink: true
    - markdown.extensions.codehilite:
        guess_lang: false
    - mdx_include:
        base_path: docs
    - admonition
    - codehilite
    - extra
    - pymdownx.superfences:
        custom_fences:
            - name: mermaid
              class: mermaid
              format: !!python/name:pymdownx.superfences.fence_div_format

plugins:
  - mkdocstrings

extra:
    social:
        - icon: 'fontawesome/brands/github-alt'
          link: 'https://github.com/kabirkhan/recon'
        - icon: 'fontawesome/brands/twitter'
          link: 'https://twitter.com/kabir_khan14'

extra_css:
    - 'css/termynal.css'
    - 'css/custom.css'

extra_javascript:
    - 'js/termynal.js'
    - 'https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js'
    - 'js/custom.js'