summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-12-11 16:50:23 -0700
committermo khan <mo@mokhan.ca>2025-12-11 16:50:23 -0700
commit2e13b50d3205e214f8ab6c64e3e69eb0ae72b938 (patch)
treeba5ab4539d1d8388e34dcb7f444165995300c760 /README.md
parentde14376f33de34e27176a7492050ac1f99867648 (diff)
fix: relative pathsHEADmain
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 21 insertions, 6 deletions
diff --git a/README.md b/README.md
index 952115c..7d80df1 100644
--- a/README.md
+++ b/README.md
@@ -11,14 +11,29 @@ gem install gitem
## Usage
```
-gitem serve # Generate and serve (default)
-gitem serve -p 3000 # Custom port
-gitem serve --open # Open browser
-gitem serve --no-generate # Serve only
-gitem generate # Generate only
-gitem generate -o ./out # Custom output
+gitem serve # Generate and serve (default)
+gitem serve -p 3000 # Custom port
+gitem serve --open # Open browser
+gitem serve --no-generate # Serve only
+gitem generate # Generate only
+gitem generate -o ./out # Custom output
+gitem generate -b /xlgmokha/gitem # With base path for subdirectory hosting
```
+### Hosting Multiple Projects
+
+When hosting multiple projects under the same domain, use the `--base-path` option:
+
+```bash
+# For https://www.mokhan.ca/xlgmokha/net-hippie/
+gitem generate -b /xlgmokha/net-hippie -o /var/www/mokhan.ca/xlgmokha/net-hippie
+
+# For https://www.mokhan.ca/xlgmokha/gitem/
+gitem generate -b /xlgmokha/gitem -o /var/www/mokhan.ca/xlgmokha/gitem
+```
+
+The base path will be automatically detected if not specified, but explicit configuration is recommended for production deployments.
+
## Requirements
- Ruby >= 3.4.0