mkdocs.yml

# Project
site_name: Rostruct
site_url: https://richie0866.github.io/Rostruct/
site_description: >-
  A modern exploiting solution, built for Roblox and Rojo.
  Deploy your project files to a Roblox script executor with a simple and flexible execution library.

# Repository
repo_name: richie0866/Rostruct
repo_url: https://github.com/richie0866/Rostruct

# Configuration
theme:
  name: material
  custom_dir: docs/assets/overrides
  
  font:
    code: JetBrains Mono
    text: Inter

  highlightjs: true

  hljs_languages:
      - typescript
      - lua

  palette:
    scheme: slate
    primary: 'blue'
    accent: 'Light blue'
    
  features:
    - navigation.tabs
    - navigation.sections

# Extra
extra_css:
  - assets/stylesheets/extra.css
  - assets/stylesheets/api-tags.css

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Plugins
plugins:
  - macros
  - search

# Page tree
nav:
  - Home: index.md

  - Getting started:
    - Overview: getting-started/overview.md
    - Installation: getting-started/installation.md
    - Usage:
      - Creating your project: getting-started/creating-your-project.md
      - Publishing your project: getting-started/publishing-your-project.md
      - Using other projects: getting-started/using-other-projects.md
      - Execution model: getting-started/execution-model.md

  - API Reference:
    - Overview: api-reference/overview.md
    - Types: api-reference/types.md
    - Rostruct:
      - Functions:
        - open: api-reference/rostruct/open.md
        - fetch: api-reference/rostruct/fetch.md
        - fetchLatest: api-reference/rostruct/fetchlatest.md
        - clearCache: api-reference/rostruct/clearcache.md
    - Package:
      - Properties: api-reference/package/properties.md
      - Methods:
        - build: api-reference/package/build.md
        - start: api-reference/package/start.md
        - require: api-reference/package/require.md
    - File conversion: api-reference/file-conversion.md
    - Globals: api-reference/globals.md

  - Featured:
    - Community: featured/community.md