aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam Scholten2025-11-27 15:05:22 +1100
committerSam Scholten2025-11-27 15:05:22 +1100
commit4c0f4bf3766ba31c2b3bafd10ace6b041d5c1e5a (patch)
tree30e3e9e67ab981f87d3b890c3a20bc6268d5f334
parent62998b501e6d79b2d53e968103050422a301cda8 (diff)
downloadacarp-marp-theme-4c0f4bf3766ba31c2b3bafd10ace6b041d5c1e5a.tar.gz
acarp-marp-theme-4c0f4bf3766ba31c2b3bafd10ace6b041d5c1e5a.zip
Improve readme, justfile cleanup etc.
-rw-r--r--README17
-rw-r--r--justfile9
-rw-r--r--package.json3
3 files changed, 27 insertions, 2 deletions
diff --git a/README b/README
index 2aaf22f..845a62f 100644
--- a/README
+++ b/README
@@ -31,7 +31,7 @@ npx marp --config .marprc.json --pdf demo-standard.md
## Example Slide
-![](egslide.png)
+<img src="egslide.png" width="350" markdown="1">
## Available Layouts
@@ -163,6 +163,20 @@ style: |
The logo appears on all slides except the title slide.
+## Using in Another Project
+
+Copy these files:
+- `acarp.css` & `acarp-beamer.css` (themes)
+- `.marprc.json` (config)
+
+Then:
+```bash
+npm install -g @marp-team/marp-cli
+marp --config .marprc.json your-file.md
+```
+
+Or clone this repo and `just new my-talk`
+
## All Commands
```bash
@@ -171,6 +185,7 @@ just watch <file> # Watch and auto-rebuild
just pdf <file> # Export to PDF
just new <name> # Create new presentation
just clean # Remove output files
+just cleanup # Clean everything including node_modules
just demo # Build demo presentations
just help # Show all commands
```
diff --git a/justfile b/justfile
index dfe3fe3..19b52f2 100644
--- a/justfile
+++ b/justfile
@@ -12,6 +12,7 @@ help:
@echo " pdf <file> - Export to PDF"
@echo " new <name> - Create presentation"
@echo " clean - Remove output files"
+ @echo " cleanup - Clean everything including node_modules"
@echo " demo - Build demo presentations"
@echo ""
@echo "Themes: acarp (16:9), acarp-beamer (4:3)"
@@ -64,6 +65,14 @@ new name:
clean:
@rm -f *.html *.pdf *.pptx
+# Clean everything including node_modules
+cleanup: clean
+ @echo "Removing node_modules..."
+ @rm -rf node_modules/
+ @echo "Removing package-lock.json..."
+ @rm -f package-lock.json
+ @echo "Cleanup complete. Run 'just install' to reinstall dependencies."
+
# Build demo presentations
demo:
@echo "Building demo-standard.md..."
diff --git a/package.json b/package.json
index fa7df3b..c1e795d 100644
--- a/package.json
+++ b/package.json
@@ -12,7 +12,8 @@
"install": "npm install",
"build": "just build",
"demo": "just demo",
- "clean": "just clean"
+ "clean": "just clean",
+ "cleanup": "just cleanup"
},
"keywords": [
"marp",