mkdocs.yml

# Copyright (c) 2016-2024 Sachin Pawaskar <sachinpawaskar@msn.com>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: CoRA Docs
site_author: Sachin Pawaskar
site_url: https://docs.coracore.org
site_description: The Commingled Remains Analytics (CoRA) web application, database and APIs are a community resource for inventorying assemblages of commingled human remains, while providing a framework of analytic methods, visualization techniques and tools to assist in the segregation and identification process.

# Repository
repo_url: https://github.com/spawaskar-cora/cora-docs
edit_uri: edit/master/docs/

# Copyright
copyright: Copyright &copy; 2016 - 2024 <a href="https://sachinpawaskaruno.github.io">Sachin Pawaskar</a> - <a href="#__consent">Change cookie settings</a><br>Maintained with ❤️ by the <a href="https://github.com/spawaskar-cora/cora-docs/graphs/contributors">CoRA Team</a>.

# Configuring/Theming the documentation 
# mkdocs comes with the theme options [mkdocs, readthedocs]
# We have installed the mkdocs-material theme as well
theme:
  name: material
  custom_dir: material/overrides
  features:
    - announce.dismiss
    # Git repository 
    # Edit this page/View source of this page
    - content.action.edit
    - content.action.view

    - content.code.annotate
    - content.code.copy
    - content.code.select
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.path
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking

    # Search capabilities
    - search.highlight
    - search.share
    - search.suggest

    # Table of contents
    - toc.follow
    # - toc.integrate

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default 
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  favicon: assets/favicon.png
  icon:
    logo: material/skull
    repo: fontawesome/brands/github
    edit: material/file-edit-outline
    view: material/file-eye-outline
    next: fontawesome/solid/angle-right
    previous: fontawesome/solid/angle-left
    admonition:
      kudos: fontawesome/solid/ruler-combined
      instrument: material/ruler-square
    #   instrument: straight_ruler
      measurement: fontawesome/solid/quote-left

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  # - git-committers:
  #     repository: spawaskar-cora/cora-docs
  #     branch: master

# Additional configuration
extra:
  annotate:
    json: [.s2]
  analytics:
    provider: google
    property: G-WRFNWMKZ4X
    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
            using our <a href="https://github.com/spawaskar-cora/cora-docs/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form</a>.
  # 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.
    social:
    - icon: fontawesome/brands/github
      link: https://github.com/SachinPawaskarUNO
      name: GitHub
    - icon: material/web
      link: https://sachinpawaskaruno.github.io/
      name: Website
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/sachinpawaskar/
      name: LinkedIn

# extra javascript
extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - assets/js/tablesort.js

# extra stylesheet
extra_css:
  - assets/css/extra.css

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - 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.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: spawaskar-cora
      repo: cora-docs
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - 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
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Navigation/Page tree
nav:
  - Home: index.md
  - Getting started:
    - getting-started/index.md
    - Philosophy: getting-started/philosophy.md
    - Conventions: getting-started/conventions.md
    - Customization: getting-started/customization.md
    - Enterprise feedback: getting-started/enterprise-support.md
    - Browser support: getting-started/browser-support.md
    - Language: getting-started/changing-the-language.md
    # - Alternatives: getting-started/alternatives.md
    # - License: getting-started/license.md
    - Changelog:
      - changelog/index.md
      - Semantic versioning: changelog/semantic-versioning.md
    - Contributing:
      - contributing/index.md
      - Reporting a bug: contributing/reporting-a-bug.md
      - Requesting a change: contributing/requesting-a-change.md
      - Reporting a docs issue: contributing/reporting-a-docs-issue.md
      - Adding translations: contributing/adding-translations.md
      - Asking a question: https://github.com/spawaskar-cora/cora-docs/discussions
  - User Guide:
    - Site Navigation:
      - user-guide/site-navigation/index.md
    - Org Users Projects: user-guide/org-users-projects.md
    - User Roles Permissions: user-guide/user-roles-permissions.md
    - Modules:
      - user-guide/modules/index.md
      - Specimens: user-guide/modules/specimens/specimens.md
      - DNA: user-guide/modules/dnas/dnas.md
      - Dental: user-guide/modules/dental/dental.md
      - Isotopes: user-guide/modules/isotopes/isotopes.md
      - Individuals: user-guide/modules/individuals/individuals.md
      - Missing Persons: user-guide/modules/missing-persons/missing-persons.md
    - Search: 
      - user-guide/search/index.md
    - Reports: 
      - user-guide/reports/index.md
      - Org reports: user-guide/reports/org-reports.md
      - User reports: user-guide/reports/user-reports.md
      - Project reports: user-guide/reports/project-reports.md
    - Dashboards: 
      - user-guide/dashboards/index.md
      - Org dashboard: user-guide/dashboards/org-dashboard.md
      - User dashboard: user-guide/dashboards/user-dashboard.md
      - Project dashboard: user-guide/dashboards/project-dashboard.md
    - File Export Import: 
      - user-guide/file-export-import/index.md
    - Mobile Readiness: 
      - user-guide/mobile-readiness/index.md
  - Forensic Anthro Guide:
    - Anomaly: forensics-anthro-guide/anomalies.md
    - Measurements: forensics-anthro-guide/measurements.md
    - Methods: forensics-anthro-guide/methods.md
    - Pathology: forensics-anthro-guide/pathologies.md
    - Taphonomy: forensics-anthro-guide/taphonomy.md
    - Trauma: forensics-anthro-guide/traumas.md
    - Zones: forensics-anthro-guide/zones.md
    - Field attributes:
      - forensics-anthro-guide/field-attributes/index.md
  - Analytics & Visualizations:
    - Home: analytics/index.md
    - Built-in analytics:
      - analytics/built-in/index.md
      - Bipartite graph: analytics/built-in/bipartite-graph.md
      - Collapsible Tree: analytics/built-in/collapsible-tree.md
      - Hierarchical Clustering: analytics/built-in/hierarchical-clustering.md
      - Hierarchical Edge Bundling: analytics/built-in/hierarchical-edge-bundling.md
      - Measurements Scatterplot: analytics/built-in/measurements-scatterplot.md
      - Osteometric Sorting Regression: analytics/built-in/osr.md
      - Refits: analytics/built-in/refits.md
      - Relationships graph: analytics/built-in/single-multiple-relationship-graph.md
  - Reference:
    - Country Language Timezone: reference/country-language-timezone.md
    - Contributing: reference/contributing.md
    - Reference list: reference/references.md
    - Icons, Emojis: reference/icons-emojis.md
    - AAFS 2018 Conference: reference/aafs-2018.md