mkdocs.yml

site_name: PromptxAI
site_url: https://www.promptx.ai
site_description: PromptxAI prepares knowledge workers for future of work, using AI to scale human capability.
copyright: Copyright &copy; 2023 - present, PromptxAI – All rights reserved | <a href="#__consent">Change cookie settings</a>

theme:
  name: material
  custom_dir: overrides
  logo: assets/images/promptxai-logo-256.png
  favicon: assets/images/favicon.png
  features:
    - content.code.copy
    - content.code.annotate
    - search.share
    - search.suggest
    - navigation.footer
    - navigation.indexes
# Vegalite not render if this is enabled
#    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - toc.follow
  palette:
      - scheme: default
        primary: 'indigo'
        accent: 'indigo'
        toggle:
          icon: material/brightness-7
          name: Switch to dark mode
      - scheme: slate
        primary: 'indigo'
        accent: 'indigo'
        toggle:
          icon: material/brightness-4
          name: Switch to light mode
  icon:
    admonition:
      note: material/chat-processing-outline
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
    tag:
      html: fontawesome/brands/html5
      js: fontawesome/brands/js
      css:  fontawesome/brands/css3
      list-creation: fontawesome/solid/list
      dataset-creation: fontawesome/solid/database
      chatgpt-model: fontawesome/solid/comments
      research-function: fontawesome/solid/brain
      education-industry: fontawesome/solid/graduation-cap
      image-generation: fontawesome/solid/image
      creative-function: material/creation
      film-industry: material/filmstrip
      midjourney-model: fontawesome/solid/eye
      engineering-function: fontawesome/solid/wrench
      software-industry: fontawesome/solid/laptop-code
      diagram-generation: fontawesome/solid/diagram-project
      knowledge-management: fontawesome/solid/brain
      consulting-industry: fontawesome/solid/handshake
      data-science: fontawesome/solid/atom
      hugging-face: fontawesome/solid/atom
      generative-ai: fontawesome/solid/brain
      openai: fontawesome/solid/brain
      chatgpt: fontawesome/solid/comments
      analytics-function: fontawesome/solid/chart-line

markdown_extensions:
  - meta
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: false
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: vegalite
          class: vegalite
          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite

  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
  - with-pdf:
      author: 'PromptxAI and ChatStart Team'
      copyright: '2022 to present, PromptxAI and ChatStart Team. All rights reserved.'
      #
      cover: true
      back_cover: true
      cover_title: 'Generative AI Playbook by PromptxAI and ChatStart'
      cover_subtitle: 'Build ChatGPT and other Generative AI powered startup. Fast!'
      #custom_template_path: TEMPLATES PATH
      #
      toc_title: 'Table of Contents'
      #heading_shift: false
      toc_level: 3
      ordered_chapter_level: 2
      #excludes_children:
      #    - 'release-notes/:upgrading'
      #    - 'release-notes/:changelog'
      #
      exclude_pages:
        - 'api/'
      #    - 'appendix/contribute/'
      #convert_iframe:
      #    - src: IFRAME SRC
      #      img: POSTER IMAGE URL
      #      text: ALTERNATE TEXT
      #    - src: ...
      # two_columns_level: 3
      #
      # render_js: true
      #headless_chrome_path: headless-chromium
      #
      output_path: ebook.pdf
      enabled_if_env: ENABLE_PDF_EXPORT
      #
      debug_html: true
      #show_anchors: true
      verbose: true    
  - charts
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - custom-skip-class-name
      auto_caption: false
      caption_position: bottom  
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - exclude-search:
      exclude:
          - api/*
      ignore:
          - api/promptxai-api.md
      exclude_unreferenced: true
  - tags:
      tags_file: tags.md
  - social:
      cards_font: Roboto
      cards_dir: images/social
      cards_color:
        fill: "#2E2E2E" 
        text: "#FFFFFF"
  - mkdocs-jupyter:
      ignore_h1_titles: True
  - minify:
      minify_html: true
      minify_js: false
      minify_css: false
      htmlmin_opts:
          remove_comments: true
      cache_safe: true
      
extra:
  analytics:
    provider: google
    property: G-WDJ90STE54
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/promptxai/promptxai
      name: PromptxAI Source on GitHub
  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.
  tags:
    HTML5: html
    JavaScript: js
    CSS: css
    List Creation: list-creation
    Dataset Creation: dataset-creation
    ChatGPT Model: chatgpt-model
    Research Function: research-function
    Education Industry: education-industry
    Image Generation: image-generation
    Film Industry: film-industry
    Creative Function: creative-function
    Midjourney Model: midjourney-model
    Engineering Function: engineering-function
    Software Industry: software-industry
    Diagram Generation: diagram-generation
    Knowledge Management: knowledge-management
    Consulting Industry: consulting-industry
    Data Science: data-science
    Hugging Face: hugging-face
    Generative AI: generative-ai
    OpenAI: openai
    ChatGPT: chatgpt
    Analytics Function: analytics-function

extra_css:
  - assets/stylesheets/extra.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/vega@5
  - https://cdn.jsdelivr.net/npm/vega-lite@5
  - https://cdn.jsdelivr.net/npm/vega-embed@6

nav:
  - Home: index.md
  - ChatGPT:
    - Historical Fact Question Answer: chatgpt/historical-fact-question-answer.md
    - Generating Diagrams from World Knowledge: chatgpt/generating-diagrams-from-world-knowledge.md
    - Natural Language Analytics and Visualization: chatgpt/natural-language-analytics-and-visualization.md
    - Tallest Buildings Data Visualization: chatgpt/tallest-buildings-dataset-visualization.md
  - Media AI:
    - Cinematic Alien Art Generation: media-ai/cinematic-alien-art-generation.md
    - Art Generation with DALL-E and Stable Diffusion: api/art-generation-with-dalle-and-stable-diffusion.ipynb
    - Interview with Stability AI CEO: stability-ai/interview-with-stability-ai-ceo.md
  - Hugging Face:
    - 5 Minutes Generative AI Developer Setup: hugging-face/5-minutes-generative-ai-developer-setup.md
    - Image Classification Using Pre-trained Deep Learning Models: api/image-classification-using-pre-trained-deep-learning-models.ipynb
  - Open AI:
    - OpenAI CEO Sam Altman on AI for the Next Era: chatgpt/openai-ceo-sam-altman-on-ai-for-the-next-era.md
    - Low-code Blog Authoring Automation: api/low-code-blog-authoring-automation.ipynb
    - Static Site Generation for Jekyll: api/static-site-generation-for-jekyll.ipynb
    - OpenAI Prompt Automation Experiments: api/openai_prompt_automation.ipynb
  - Models:
    - Large Language Models: models/large-language-models.md
    - DALL-E Mini: models/dalle-mini.md
    - LaMDA: models/lamda.md
    - LLaMA: models/llama.md
    - BERT Base Model Uncased: models/bert-base-model-uncased.md
    - GPT-3: models/generative-pretrained-transformer-gpt3.md
    - Flan 20B: models/flan-20b.md
  - Design:
    - Intersection of Generative AI and Product Design: design/generative-ai-ux-design.md
    - Design Playbook Series - AI-Powered Experience Design: design/design-playbook-ai-powered-experience-design.md
    - Design Playbook Series - Navigating the Risks and Limitations of AI in Design: design/navigating-the-risks-and-limitations-of-AI-in-design.md
  - API:
    - PromptxAI API: api/promptxai-api.md
    - Playbook:
      - Models API: api/promptxai/models.py
      - Prompts API: api/promptxai/prompts.py
      - Utils API: api/promptxai/utils.py
      - Content API: api/promptxai/content.py
    - Notebooks:
      - Model Card Generator: api/model-card-generator.ipynb
    - Legacy:
      - Blogger API: api/promptxai/blogger.py
      - Artist API: api/promptxai/artist.py
      - Core API: api/promptxai/core.py
  - Tags: tags.md