quartz build

README.md

@@ -0,0 +1,60 @@
+# org-to-quartz
+
+Convert org-mode notes to a Quartz static site.
+
+## Quick Start
+
+### Build pages from your notes
+
+```bash
+nix build .#example-pages
+# Output in ./result/
+```
+
+### Serve locally (development)
+
+```bash
+nix run .#serve ./path/to/your/notes
+# Opens http://localhost:8080
+```
+
+### Convert org to markdown only
+
+```bash
+nix run . -- ./input-notes ./output-dir
+```
+
+## Use in your own flake
+
+```nix
+{
+  inputs.org-notes-quartz.url = "github:your-user/org-notes-quartz";
+
+  outputs = { self, nixpkgs, org-notes-quartz, ... }:
+    let
+      system = "x86_64-linux";
+      buildQuartzPages = org-notes-quartz.lib.${system}.buildQuartzPages;
+    in {
+      packages.${system}.site = buildQuartzPages {
+        contentDir = ./notes;
+        # quartzConfig = ./quartz.config.ts;  # optional
+        # quartzLayout = ./quartz.layout.ts;  # optional
+      };
+    };
+}
+```
+
+## Available packages
+
+| Package                     | Description                                 |
+|-----------------------------|---------------------------------------------|
+| `default` / `org-to-quartz` | CLI to convert org files to Quartz markdown |
+| `quartz`                    | Quartz v4.5.2 static site generator         |
+| `example-pages`             | Example build from `test-notes/`            |
+
+## Available apps
+
+| App       | Description                   |
+|-----------|-------------------------------|
+| `default` | Run org-to-quartz converter   |
+| `serve`   | Serve notes with live preview |