aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam Scholten2025-10-20 08:07:51 +1000
committerSam Scholten2025-10-20 08:07:51 +1000
commit684f9796003a5eb0e3fea1ec3b1a6d273065f70e (patch)
tree556f5eabe49d7062380786efe6aadaaa423e459d
parent907e83bf1bb336012422a7dc8925d627ae86b832 (diff)
downloadacarp-marp-theme-684f9796003a5eb0e3fea1ec3b1a6d273065f70e.tar.gz
acarp-marp-theme-684f9796003a5eb0e3fea1ec3b1a6d273065f70e.zip
clean up readme
-rw-r--r--README54
1 files changed, 5 insertions, 49 deletions
diff --git a/README b/README
index 8efe4c7..8f69673 100644
--- a/README
+++ b/README
@@ -2,15 +2,10 @@
<img src="acarp.png" width="120" markdown="1">
-A minimal, grid-based theme for Marp presentations designed for academic content.
+A minimal theme for Marp presentations designed for academic content.
+Has a CSS grid (2 columns) for easily showing text alongside figures.
-## Features
-
-- **Grid-only layouts** - CSS Grid for all presentation layouts
-- **Two aspect ratios** - 16:9 (standard) and 4:3 (beamer)
-- **Academic focus** - Optimized for equations, code, and technical content
-- **Explicit contracts** - Clear, maintainable CSS structure
-- **No utility classes** - Focus on content, not class names
+Two aspect ratios: 16:9 (standard) and 4:3 (beamer style).
## Quick Start
@@ -24,6 +19,8 @@ npm install
# Using just (recommended)
just demo # Build both demo presentations
+just build slides.md # or use `just pdf slides.md` (requires chrome/chromium)
+
# Using npx directly
npx marp --config .marprc.json --html demo-standard.md
npx marp --config .marprc.json --html demo-beamer.md
@@ -90,16 +87,6 @@ def hello(name):
## Themes
-### Standard (16:9)
-- Dimensions: 1280x720px
-- Use default theme
-- For modern widescreen presentations
-
-### Beamer (4:3)
-- Dimensions: 1280x960px
-- Use filename with "beamer": `talk-beamer.md`
-- For classic LaTeX Beamer-style presentations
-
## Customization
### Theme Variables
@@ -133,12 +120,6 @@ style: |
---
```
-Common font sizes:
-- Standard theme: 28px (default)
-- Beamer theme: 37px (default)
-- Large print: 32-36px
-- Compact: 24-26px
-
### Logo Placement
Add a logo to the top-right corner using CSS variables in your frontmatter:
@@ -180,31 +161,6 @@ just demo # Build demo presentations
just help # Show all commands
```
-## Design Philosophy
-
-The theme is built on a simple principle: use CSS Grid exclusively for layout. This means:
-
-- **Grid only** - No flexbox for layouts (flexbox is for UI components)
-- **Explicit contracts** - Grid areas and templates are clearly defined
-- **Minimal abstraction** - No utility classes, no hidden behaviors
-- **Maintainable** - One base theme, one beamer override
-
-## Directory Structure
-
-```
-acarp-marp-theme/
-├── figs/ # Images directory
-├── acarp.css # Base theme (all layouts)
-├── acarp-beamer.css # Beamer overrides (4:3 only)
-├── .marprc.json # Marp configuration
-├── template.md # Example presentation
-├── demo-standard.md # Standard 16:9 example
-├── demo-beamer.md # Beamer 4:3 example
-├── package.json # Dependencies
-├── justfile # Build commands
-└── README.md # This file
-```
-
## Notes
- Images: `![](figs/imagename.png)`