ralphify/mkdocs.yml at main · computerlovetech/ralphify · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
site_name: Ralphify
site_description: A minimal CLI harness for autonomous AI coding loops — run commands, assemble a prompt, pipe it to an agent, and repeat with fresh context each iteration.
site_url: https://ralphify.co/docs/
repo_url: https://github.com/computerlovetech/ralphify
repo_name: computerlovetech/ralphify
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2025–2026 Computerlove Technologies

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.indexes
    - navigation.sections
    - navigation.path
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
  favicon: assets/favicon.svg
  icon:
    logo: material/run
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      base_path: ["."]
  - toc:
      permalink: true

plugins:
  - search:
      separator: '[\s\-\.]+'
      lang: en
  - blog:
      blog_dir: blog
      blog_toc: true
      post_date_format: long
      post_url_format: "{slug}"
      post_readtime: true
      post_excerpt: required
      categories: true
      archive: true
      authors: true
      pagination_per_page: 10
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
      fallback_to_build_date: true
      exclude:
        - blog/archive/*
        - blog/category/*
        - blog/posts/*

extra_css:
  - stylesheets/extra.css

extra:
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve by
            <a href="https://github.com/computerlovetech/ralphify/issues/new?title=[docs]+{title}+-+{url}" target="_blank" rel="noopener">opening an issue</a>.
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/computerlovetech/ralphify
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ralphify/

nav:
  - Home: index.md
  - Guide:
    - Getting Started: getting-started.md
    - How it Works: how-it-works.md
    - Using with Different Agents: agents.md
    - Cookbook: cookbook.md
  - Reference:
    - Quick Reference: quick-reference.md
    - CLI: cli.md
    - Python API: api.md
  - Blog: blog/index.md
  - Help:
    - Troubleshooting: troubleshooting.md
    - Changelog: changelog.md
  - Contributing:
    - contributing/index.md
    - Codebase Map: contributing/codebase-map.md