@@ -4,11 +4,10 @@ This repository hosts the code for [minimal-agent.com](https://minimal-agent.com
44
55## Structure
66
7- - ` tutorial.md ` - Main content in Markdown format
8- - ` template.html ` - HTML template for the static site
9- - ` static/ ` - Static assets (CSS, etc.)
10- - ` build.py ` - Python script to generate the static HTML website
11- - ` output/ ` - Generated static website (git-ignored)
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)
1211
1312## Building the Site
1413
@@ -19,40 +18,50 @@ This repository hosts the code for [minimal-agent.com](https://minimal-agent.com
1918
20192 . Build the site:
2120 ``` bash
22- python build.py
21+ mkdocs build
2322 ```
2423
25- 3 . The generated site will be in the ` output /` directory. Open ` output /index.html` in your browser.
24+ 3 . The generated site will be in the ` site /` directory. Open ` site /index.html` in your browser.
2625
2726## Development Mode
2827
29- For live development with automatic rebuilding:
28+ For live development with automatic rebuilding and hot reload :
3029
3130``` bash
32- python build.py -- serve
31+ mkdocs serve
3332```
3433
3534This will:
3635- Start a local server at ` http://localhost:8000 `
37- - Watch for changes to ` .md ` , ` .html ` , ` .css ` , and ` .js ` files
38- - Automatically rebuild the site when files change
39- - Just refresh your browser to see updates !
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!
4039
4140You can specify a custom port:
4241
4342``` bash
44- python build.py --serve --port 3000
43+ mkdocs serve -a localhost:3000
44+ ```
45+
46+ ## Deployment
47+
48+ To deploy to GitHub Pages:
49+
50+ ``` bash
51+ mkdocs gh-deploy
4552```
4653
4754## Markdown Features
4855
49- The site supports:
56+ The site uses [ Material for MkDocs] ( https://squidfunk.github.io/mkdocs-material/ ) and supports:
57+
5058- Standard Markdown syntax
5159- Inline HTML content
52- - Code blocks with syntax highlighting
60+ - Code blocks with syntax highlighting and line numbers
5361- Admonitions (notes, warnings, etc.)
5462- Tabbed content
5563- Collapsible sections (details/summary)
64+ - Dark/light theme toggle
5665
5766### Example Admonition
5867
@@ -79,4 +88,3 @@ Use `!!!` syntax for admonitions:
7988??? "Click to expand"
8089 Hidden content here
8190```
82-
0 commit comments