mkdocs.yml

# Readme-ai MkDocs Site Configuration

site_name: Readme-ai Docs
site_description: "🎈 Automated README file generator, powered by GPT language model APIs."
site_url: https://eli64s.github.io/readme-ai/
site_author: readme-ai
repo_url: https://github.com/eli64s/readme-ai
repo_name: eli64s/readme-ai
docs_dir: "docs/docs/"

theme:
  icon:
    repo: fontawesome/brands/github-alt
  name: material
  palette:
    primary: white
    accent: blue
  language: en
  font:
    text: "Roboto"
    code: "Roboto Mono"
  features:
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.prune
    - navigation.footer
    - navigation.tracking
    - navigation.instant
    - navigation.instant.progress
    - navigation.indexes
    - navigation.sections


nav:
  - Home: index.md
  - Installation: installation.md
  - Getting Started:
      - "Prerequisites": prerequisites.md
      - "Running the CLI": usage.md
      - "CLI Commands": cli_commands.md
  - Features: features.md
  - Examples: examples.md
  - Concepts:
      - "Core Concepts": concepts.md
      - "How It Works": how_it_works.md
      - "Pydantic Models": pydantic_models.md
  - Contributing: contributing.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html

extra_css:
  - css/custom.css
  - css/termynal.css

extra_javascript:
  - js/custom.js
  - js/termynal.js

plugins:
  - search