|
1 | | -# Minimal Agent Website |
| 1 | +# Minimal Agent Tutorial |
2 | 2 |
|
3 | | -This repository hosts the code for [minimal-agent.com](https://minimal-agent.com), a minimalistic one-page website that teaches you how to build a minimal AI agent for terminal use. |
| 3 | +> Source code for [minimal-agent.com](https://minimal-agent.com) — a tutorial that teaches you how to build an AI coding agent from scratch. |
4 | 4 |
|
5 | | -## Structure |
| 5 | +## What is this? |
6 | 6 |
|
7 | | -- `docs/index.md` - Main content in Markdown format |
8 | | -- `docs/stylesheets/` - Custom CSS for the site |
9 | | -- `mkdocs.yml` - MkDocs configuration |
10 | | -- `site/` - Generated static website (git-ignored) |
| 7 | +This repo contains the **documentation website** for the Minimal Agent tutorial. It's a static site built with MkDocs that teaches developers how to build a terminal-based AI agent in ~60 lines of Python. |
11 | 8 |
|
12 | | -## Building the Site |
| 9 | +**Looking for the actual agent code?** |
| 10 | +- 📦 [mini-swe-agent](https://github.com/SWE-agent/mini-swe-agent) — The full implementation. |
| 11 | +- 📄 [minimal-agent.com](https://minimal-agent.com) — The tutorial (copy-paste code from here) |
13 | 12 |
|
14 | | -1. Install dependencies: |
15 | | - ```bash |
16 | | - pip install -r requirements.txt |
17 | | - ``` |
18 | 13 |
|
19 | | -2. Build the site: |
20 | | - ```bash |
21 | | - mkdocs build |
22 | | - ``` |
23 | | - |
24 | | -3. The generated site will be in the `site/` directory. Open `site/index.html` in your browser. |
25 | | - |
26 | | -## Development Mode |
27 | | - |
28 | | -For live development with automatic rebuilding and hot reload: |
| 14 | +## Local development |
29 | 15 |
|
30 | 16 | ```bash |
| 17 | +pip install -r requirements.txt |
31 | 18 | mkdocs serve |
32 | 19 | ``` |
33 | 20 |
|
34 | | -This will: |
35 | | -- Start a local server at `http://localhost:8000` |
36 | | -- Watch for changes to markdown and configuration files |
37 | | -- Automatically rebuild and reload the site when files change |
38 | | -- No need to refresh your browser! |
39 | | - |
40 | | -You can specify a custom port: |
41 | | - |
42 | | -```bash |
43 | | -mkdocs serve -a localhost:3000 |
44 | | -``` |
45 | | - |
46 | | -## Deployment |
47 | | - |
48 | | -To deploy to GitHub Pages: |
49 | | - |
50 | | -```bash |
51 | | -mkdocs gh-deploy |
52 | | -``` |
| 21 | +Then open http://localhost:8000 |
53 | 22 |
|
54 | | -## Markdown Features |
| 23 | +## Contributing |
55 | 24 |
|
56 | | -The site uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and supports: |
| 25 | +The tutorial content is in `docs/index.md`. Edit that file and submit a PR. |
57 | 26 |
|
58 | | -- Standard Markdown syntax |
59 | | -- Inline HTML content |
60 | | -- Code blocks with syntax highlighting and line numbers |
61 | | -- Admonitions (notes, warnings, etc.) |
62 | | -- Tabbed content |
63 | | -- Collapsible sections (details/summary) |
64 | | -- Dark/light theme toggle |
65 | | - |
66 | | -### Example Admonition |
67 | | - |
68 | | -Use `!!!` syntax for admonitions: |
69 | | - |
70 | | -```markdown |
71 | | -!!! note "This is a note" |
72 | | - This is the content of the note. |
73 | | -``` |
74 | | - |
75 | | -### Example Tabbed Content |
76 | | - |
77 | | -```markdown |
78 | | -=== "Tab 1" |
79 | | - Content for tab 1 |
80 | | - |
81 | | -=== "Tab 2" |
82 | | - Content for tab 2 |
83 | | -``` |
84 | | - |
85 | | -### Example Foldout |
86 | | - |
87 | | -```markdown |
88 | | -??? "Click to expand" |
89 | | - Hidden content here |
90 | | -``` |
| 27 | +This site uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) which supports admonitions, tabs, code highlighting, and more. |
0 commit comments