mkdocs.yaml

# SPDX-License-Identifier: Apache-2.0
#
# Copyright 2023-2024 The Enola <https://enola.dev> Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# https://squidfunk.github.io/mkdocs-material/creating-your-site/
# https://www.mkdocs.org/user-guide/configuration/

site_name: Enola.dev
site_url: https://www.enola.dev
repo_url: https://github.com/enola-dev/enola
edit_uri: blob/main/docs/
copyright: Copyright &copy; 2023-2024 The Enola <https://enola.dev> Authors

nav:
  - Tutorial:
      - Tutorials:
          - Introduction: index.md
          - Download: use/index.md
          - Hello World: models/example.org/hello.md
          - Linked Data: models/example.org/linked.md
          - Classy: models/example.org/class.md
          - Graph: models/example.org/graph.md
          - Timeline: models/example.org/timeline.md
          - Templates: models/example.org/templates.md
          - JSON-LD: models/example.org/json-ld.md
      - News (Blog):
          - April 2024 News: blog/posts/2024-04.md
          - Linked Thing UI: blog/posts/ui1.md
          - DocGen v0.1: blog/posts/docgen1.md
          - First Model: blog/posts/model1.md
          - Repo Created: blog/posts/git-repo-created.md
  - Tools:
      - Help: use/help/index.md
      - Example Model: use/library/index.md
      - DocGen: use/docgen/index.md
      - Get Thing: use/get/index.md
      - Server: use/server/index.md
      - Rosetta: use/rosetta/index.md
      - JSON-LD: use/json-ld/index.md
      - Canonicalize: use/canonicalize/index.md
      - ExecMD: use/execmd/index.md
      - Info: use/info/index.md
  - Models:
      - By Type: models/index.md
      - By Parent: models/hierarchy.md
      - Graph: concepts/graph.md
      - Timeline: concepts/timeline.md
      - Enola:
          - MIME Simple: models/enola.dev/mediaType/graph.gv.svg
          - MIME Full: models/enola.dev/mediaType/graphviz.gv.svg
  - Concepts:
      - Core: concepts/core.md
      - Architecture Diagrams: concepts/core-arch.md
      - Roadmap: concepts/roadmap.md
      - Singularity: concepts/singularity.md
      - URL & ID: concepts/uri.md
      - Metadata: concepts/metadata.md
      - Namespaces: concepts/namespaces.md
      - Formats:
          - RDF:
              - Turtle: concepts/turtle.md
              - RDF XML: concepts/xml-rdf.md
          - "* Tika": concepts/tika.md
          - XML: concepts/xml.md
  - Developers:
      - Set-Up: dev/setup.md
      - IDE: dev/ide.md
      - Architecture: concepts/implementation.md
      - Code Conventions: dev/style.md
      - Protocol Buffer API:
          - Thing Proto: dev/proto/thing.md
          - Core Proto: dev/proto/core.md
      - Implementation Details: dev/implementation.md
      - Bazel: dev/bazel.md
      - Dependencies: dev/dependencies.md
      - Contributor Guide: contributing.md
      - Code of Conduct: code-of-conduct.md
  # - Kubernetes:
  #     - Introduction: k8s/index.md
  #     - Demo: k8s/demo.md
  - Appendix:
      # - Playbooks: concepts/playbook.md
      - Comparison: concepts/other.md
      - Security Policy: SECURITY.md

not_in_nav: |
  models/**
  blog/posts/*.md

exclude_docs: |
  BUILD

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  nav:
    # TODO Eventually make omitted_files warn instead of info...
    omitted_files: info
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    # TODO Eventually make anchors warn instead of info...
    anchors: info
    absolute_links: warn
    unrecognized_links: warn

theme:
  logo: images/enola-293_293-transparent.png
  favicon: images/enola-293_293-transparent.png
  name: material
  features:
    - content.action.edit
    - content.code.copy
    - navigation.footer
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.path
    - navigation.top
    # - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - search.suggest
    - search.share
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      accent: lime
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode

markdown_extensions:
  - footnotes
  - tables
  - smarty
  - toc:
      permalink: true
  # https://squidfunk.github.io/mkdocs-material/reference/admonitions/
  - admonition
  - pymdownx.details
  # https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/
  - pymdownx.magiclink
  # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
  - pymdownx.highlight:
    # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight
    # anchor_linenums: true
    # line_spans: __span
    # pygments_lang_class: true
  # https://squidfunk.github.io/mkdocs-material/reference/diagrams/
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  analytics:
    provider: google
    property: G-W0WFEQPB8E
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/heart
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/heart-broken
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Please <a
            href="https://github.com/enola-dev/enola/issues/new/?title=[Feedback]+{title}&body=On+https://docs.enola.dev{url},+...&labels=documentation"
            target="_blank" rel="noopener">suggest how to improve this page</a>?

plugins:
  - search

  # https://github.com/mondeja/mkdocs-include-markdown-plugin (ASL)
  # Possible alternative: https://github.com/cmacmackin/markdown-include (GPL)
  - include-markdown

  - git-revision-date-localized:
      strict: false
      exclude:
        - dev/proto/*
        - models/*

  # TODO Activate the following plugin once I will pay $15/month for
  # https://squidfunk.github.io/mkdocs-material/insiders/

  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/
  # - blog

extra_javascript:
  - https://unpkg.com/mustache@latest
  - javascripts/var-replacer.js