mkdocs.yml

site_name: Griptape Trade School
copyright: "© Griptape, Inc."
plugins:
  #- glightbox
  - search
extra_css:
  - assets/css/extra.css
extra_javascript:
  - "js/adjust-button.js"
extra:
  analytics:
    provider: google
    property: G-68THEKV8C8
  social:
    - icon: fontawesome/solid/house
      link: https://www.griptape.ai
    - icon: fontawesome/brands/discord
      link: https://discord.gg/gnWRz88eym
    - icon: fontawesome/brands/github
      link: https://github.com/griptape-ai/griptape/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@griptape-ai
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/griptape/
theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/img/griptape-logo-light.png
  palette:
    scheme: slate
    primary: black
    accent: deep orange
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.instant
    # - navigation.sections
    - navigation.path
    # - navigation.indexes
    - navigation.footer
    # - navigation.expand
    - navigation.prune
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.annotate
    - content.code.copy
    # - navigation.awesome-pages
    - content.code.annotate
  language: en
markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - attr_list
  - md_in_html
  - tables
  - def_list
  - toc:
      toc_depth: 3
      title: On this page
      # permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      # linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.blocks.details
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.mark
  - pymdownx.betterem
  - pymdownx.emoji:
      # emoji_index: !!python/name:material.extensions.emoji.twemoji
      # emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde

#Navigation
nav:
  - Home:
      - Griptape Trade School: "index.md"
  - Setup:
      - Setting up for Griptape: setup/index.md
      - Software: setup/01_setting_up_environment.md
      - OpenAI: setup/02_openai.md
      - Griptape: setup/03_griptape.md
      - Resources: setup/04_helpful_resources.md
  - Courses:
      - All Courses: courses.md
      - Chatbot - Rulesets:
          - Introduction: courses/chatbot-rulesets/index.md
          - Setup: courses/chatbot-rulesets/01_setting_up_environment.md
          - The Chat utility: courses/chatbot-rulesets/03_the_chat_utility.md
          - Showing the logs: courses/chatbot-rulesets/04_show_the_logs.md
          - Personality: courses/chatbot-rulesets/05_personality_with_rulesets.md
          - Custom chat: courses/chatbot-rulesets/06_adding_manual_chat.md
          - Manners maketh the bot: courses/chatbot-rulesets/07_manners_maketh_the_bot.md
          - Rulesets for output: courses/chatbot-rulesets/08_adding_another_ruleset_for_output.md
          - Formatting Output: courses/chatbot-rulesets/09_formatting_chat_output.md
          - Markdown Madness: courses/chatbot-rulesets/10_markdown_madness.md
          - Improving the Prompt: courses/chatbot-rulesets/11_gleaming_the_chat.md
          - Multiple Personas: courses/chatbot-rulesets/12_multiple_personas.md
          - Colorful Personality: courses/chatbot-rulesets/13_adding_personality_colors.md
          - Quick Feedback: courses/chatbot-rulesets/14_making_it_quick.md
      - Compare Movies - Workflows:
          - Introduction: courses/compare-movies-workflow/index.md
          - Setup: courses/compare-movies-workflow/01_setup.md
          - Concepts: courses/compare-movies-workflow/02_concepts.md
          - First Workflow: courses/compare-movies-workflow/03_first_workflow.md
          - Adding Flexibility: courses/compare-movies-workflow/04_adding_flexibility.md
          - Using Tools: courses/compare-movies-workflow/05_using_tools.md
          - Workflow Outputs: courses/compare-movies-workflow/06_workflow_outputs.md
          - Workflow Structure Visualizer: courses/compare-movies-workflow/07_workflow_structure_visualizer.md
          - Updates To Workflows: courses/compare-movies-workflow/08_updates_imperative_vs_desclarative.md
      - Image Generation - Pipelines:
          - Introduction: courses/create-image-pipeline/index.md
          - Setup: courses/create-image-pipeline/01_setup.md
          - Concepts: courses/create-image-pipeline/02_concepts.md
          - First Pipeline: courses/create-image-pipeline/03_first_pipeline.md
          - Creating Images: courses/create-image-pipeline/04_creating_images.md
          - Displaying Images: courses/create-image-pipeline/07_display_image_task.md
          - DALL·E 3: courses/create-image-pipeline/08_dalle-3.md
          - Leonardo.AI: courses/create-image-pipeline/09_leonardo-ai.md
          - Amazon Bedrock: courses/create-image-pipeline/10_amazon-bedrock.md
      - Griptape and Shotgrid - Tools:
          - Introduction: courses/shotgrid-tool/index.md
          - Setup: courses/shotgrid-tool/01_setup.md
          - Understanding Tools: courses/shotgrid-tool/03_understanding_tools.md
          - Your First Tool: courses/shotgrid-tool/04_first_tool.md
          - ShotGrid Signup: courses/shotgrid-tool/02_shotgrid.md
          - ShotGrid Tool: courses/shotgrid-tool/05_shotgrid_tool.md
          - User Authentication: courses/shotgrid-tool/06_shotgrid_user.md
          - ShotGrid Methods: courses/shotgrid-tool/07_method.md
          - Vectorized Docs: courses/shotgrid-tool/08_vectorized_docs.md
          - Rules and Rulesets: courses/shotgrid-tool/09_rules.md
      - Image Query SEO Bonanza:
          - Introduction: courses/image-query/index.md
          - Setup: courses/image-query/01_setup.md
          - Chatbot: courses/image-query/02_chatbot.md
          - ImageQuery: courses/image-query/03_image_query_tool.md
          - SEO Friendly: courses/image-query/04_seo_friendly.md
          - Saving to Disk: courses/image-query/05_save_to_disk.md
          - Multiple Images: courses/image-query/06_querying_multiple_images.md
          - Template: courses/image-query/07_template.md
      - Structures calling Structures:
          - Introduction: courses/structures-calling-structures/index.md
          - Setup: courses/structures-calling-structures/01_setup.md
          - Concepts: courses/structures-calling-structures/02_concepts.md
          - Image Pipeline: courses/structures-calling-structures/03_image_pipeline.md
          - Drawing Agent: courses/structures-calling-structures/04_drawing_agent.md
  - Help:
      - FAQ: faq.md
      - Contributing: contributing.md
      - Troubleshooting: troubleshooting.md