mkdocs.yml

# Site info
site_name: NLR::docs
site_url: https://nitis-languages.github.io/
site_author: NiTiS-Dev
site_description: >-
  Documentation all about NLR.
  NiTiS Languages' Runtime manages the execution of NiTiS programs

# Repository info
repo_url: https://github.com/nitis-languages/nitis-languages.github.io/
repo_name: nitis-languages/docs

edit_uri_template: blob/site/docs/{path}?plain=1

# Copyright
copyright: Copyright © 2024 NiTiS-Dev

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.ico
  custom_dir: overrides
  icon:
    alternate: material/translate-variant
    repo: material/github
    previous: fontawesome/solid/angle-left
    next: fontawesome/solid/angle-right
  palette: 
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  features:
    - search.suggest # Suggestion while search
    - search.highlight # Highlight search phrase 
    - search.share # Share search result
    - content.code.copy # Copy button at edge of code block
    - content.code.annotate # Annotations inside code block
    - content.action.edit # Edit button on begin of page
    - content.action.view # View button on begin of page
    - navigation.sections # More prettier view of pages; Off this to enable tree view
    - navigation.tabs # Root pages are tabs now
    - navigation.top # Back to top button
    - navigation.instant # Use XHR to prevent page reload
    - navigation.instant.progress # Shows progress of instant loading?
    - navigation.tracking # Dynamically update link during page reading
    - toc.follow # Toc following

plugins:
  - search # Search bar
  - minify:
      minify_html: true # Makes html human-readable
  - social: # Social card (for Discord, Twitter, etc.)
      cards_layout_options:
        background_color: "#242048" # The same color as in the logo

watch: # Directories, that need to included
  - includes

markdown_extensions:
  - abbr # Abbreviation support
  - admonition # Admonitions
  - attr_list # Append attributes in markdown
  - md_in_html # Use tables, etc.
  - toc: # Table of content on right
      permalink: true
  - pymdownx.tabbed: # Tabs, that you can switch
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences

extra_javascript:
  - /scripts/feedback.js
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - /scripts/tablesort.js

extra:
  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.
    cookies:
      analytics: Google Analytics

  social:
    - icon: material/github
      link: https://github.com/nitis-languages
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
    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://forms.gle/tjeWpdtSDRXyR4dG8" target="_blank" rel="noopener">feedback form</a>.

nav:
  - index.md
  - Runtime:
    - runtime/access.md
    - runtime/inheritance.md
    - runtime/bytecode/list.md
    - Bytecodes:
      - runtime/bytecode/nope.md
      - runtime/bytecode/break.md
      - runtime/bytecode/push.md
      - runtime/bytecode/store.md
      - runtime/bytecode/add.md
      - runtime/bytecode/sub.md
  - Guidelines:
    - guidelines/coding-style.md
    - guidelines/naming-guideline.md
  - NiteCode:
    - Tutorials:
      - nite-code/tutorial/hello-world.md