From 6f67b1bc2ccadb79543d4ed0e5246c769a4e91aa Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Mon, 27 Nov 2023 19:10:08 -1000 Subject: [PATCH] switch to a mdbook-like file layout, using src/ and out/ Unlike mdbook, the out/ directory contains needed assets and is not expendable. --- Makefile | 12 ++++++------ {css => out/css}/normalize.css | 0 {css => out/css}/site.css | 0 {css => out/css}/skeleton.css | 0 {images => out/images}/favicon.png | Bin {images => out/images}/pta-avatar.jpg | Bin {quickref => out/quickref}/images/image00.jpg | Bin {quickref => out/quickref}/quickref.css | 0 index.tmpl => page.tmpl | 0 index.md => src/index.md | 0 {quickref => src/quickref}/a.beancount | 0 {quickref => src/quickref}/a.hledger | 0 {quickref => src/quickref}/a.ledger | 0 {quickref => src/quickref}/index.md | 2 ++ {quickref => src/quickref}/quickref-beancount.md | 4 +++- {quickref => src/quickref}/quickref-hledger.md | 4 +++- {quickref => src/quickref}/quickref-ledger.md | 4 +++- {quickref => src/quickref}/tests.shelltest | 0 18 files changed, 17 insertions(+), 9 deletions(-) rename {css => out/css}/normalize.css (100%) rename {css => out/css}/site.css (100%) rename {css => out/css}/skeleton.css (100%) rename {images => out/images}/favicon.png (100%) rename {images => out/images}/pta-avatar.jpg (100%) rename {quickref => out/quickref}/images/image00.jpg (100%) rename {quickref => out/quickref}/quickref.css (100%) rename index.tmpl => page.tmpl (100%) rename index.md => src/index.md (100%) rename {quickref => src/quickref}/a.beancount (100%) rename {quickref => src/quickref}/a.hledger (100%) rename {quickref => src/quickref}/a.ledger (100%) rename {quickref => src/quickref}/index.md (99%) rename {quickref => src/quickref}/quickref-beancount.md (98%) rename {quickref => src/quickref}/quickref-hledger.md (98%) rename {quickref => src/quickref}/quickref-ledger.md (99%) rename {quickref => src/quickref}/tests.shelltest (100%) diff --git a/Makefile b/Makefile index 79f6bf6..6f9a641 100644 --- a/Makefile +++ b/Makefile @@ -1,18 +1,18 @@ all: html -# Generate html from all md files +# Generate html from all md files in src/, in out/ # (including README, maybe useful for local preview. $(filter-out README.md, ...) to exclude). -html: $(patsubst %.md,%.html,$(wildcard *.md quickref/*.md)) Makefile +html: $(patsubst src/%,out/%,$(patsubst %.md,%.html,$(wildcard src/*.md src/quickref/*.md))) Makefile PANDOC=pandoc -f markdown-smart-tex_math_dollars+autolink_bare_uris # generate html from a md file -%.html: %.md index.tmpl - $(PANDOC) --template index.tmpl $< -o $@ +out/%.html: src/%.md page.tmpl + $(PANDOC) --template page.tmpl $< -o $@ # regenerate html whenever an md file changes html-auto auto: - ls *.md quickref/*.md | entr make html + watchexec -- make html BROWSE=open LIVERELOADPORT=8100 @@ -25,7 +25,7 @@ LIVERELOAD=livereloadx -p $(LIVERELOADPORT) -s html-watch watch: make html-auto & (sleep 1; $(BROWSE) http://localhost:$(LIVERELOADPORT)/) & - $(LIVERELOAD) . + $(LIVERELOAD) out # regenerate syntax quick reference html from google docs html export # (it has been manually edited, let's not do this again) diff --git a/css/normalize.css b/out/css/normalize.css similarity index 100% rename from css/normalize.css rename to out/css/normalize.css diff --git a/css/site.css b/out/css/site.css similarity index 100% rename from css/site.css rename to out/css/site.css diff --git a/css/skeleton.css b/out/css/skeleton.css similarity index 100% rename from css/skeleton.css rename to out/css/skeleton.css diff --git a/images/favicon.png b/out/images/favicon.png similarity index 100% rename from images/favicon.png rename to out/images/favicon.png diff --git a/images/pta-avatar.jpg b/out/images/pta-avatar.jpg similarity index 100% rename from images/pta-avatar.jpg rename to out/images/pta-avatar.jpg diff --git a/quickref/images/image00.jpg b/out/quickref/images/image00.jpg similarity index 100% rename from quickref/images/image00.jpg rename to out/quickref/images/image00.jpg diff --git a/quickref/quickref.css b/out/quickref/quickref.css similarity index 100% rename from quickref/quickref.css rename to out/quickref/quickref.css diff --git a/index.tmpl b/page.tmpl similarity index 100% rename from index.tmpl rename to page.tmpl diff --git a/index.md b/src/index.md similarity index 100% rename from index.md rename to src/index.md diff --git a/quickref/a.beancount b/src/quickref/a.beancount similarity index 100% rename from quickref/a.beancount rename to src/quickref/a.beancount diff --git a/quickref/a.hledger b/src/quickref/a.hledger similarity index 100% rename from quickref/a.hledger rename to src/quickref/a.hledger diff --git a/quickref/a.ledger b/src/quickref/a.ledger similarity index 100% rename from quickref/a.ledger rename to src/quickref/a.ledger diff --git a/quickref/index.md b/src/quickref/index.md similarity index 99% rename from quickref/index.md rename to src/quickref/index.md index c3d9a67..e56a34e 100644 --- a/quickref/index.md +++ b/src/quickref/index.md @@ -1,3 +1,5 @@ +% Syntax Quick Reference for the Ledger-Likes + diff --git a/quickref/quickref-beancount.md b/src/quickref/quickref-beancount.md similarity index 98% rename from quickref/quickref-beancount.md rename to src/quickref/quickref-beancount.md index 2abd053..78edb24 100644 --- a/quickref/quickref-beancount.md +++ b/src/quickref/quickref-beancount.md @@ -1,7 +1,9 @@ - +% Syntax quick reference: Beancount # Syntax quick reference: Beancount + + [Big 3](index.html) | [Ledger](quickref-ledger.html) | [hledger](quickref-hledger.html) diff --git a/quickref/quickref-hledger.md b/src/quickref/quickref-hledger.md similarity index 98% rename from quickref/quickref-hledger.md rename to src/quickref/quickref-hledger.md index 19ec66c..75c354f 100644 --- a/quickref/quickref-hledger.md +++ b/src/quickref/quickref-hledger.md @@ -1,7 +1,9 @@ - +% Syntax quick reference: hledger # Syntax quick reference: hledger + + [Big 3](index.html) | [Ledger](quickref-ledger.html) | [hledger](quickref-hledger.html) diff --git a/quickref/quickref-ledger.md b/src/quickref/quickref-ledger.md similarity index 99% rename from quickref/quickref-ledger.md rename to src/quickref/quickref-ledger.md index 99426c7..882ca38 100644 --- a/quickref/quickref-ledger.md +++ b/src/quickref/quickref-ledger.md @@ -1,7 +1,9 @@ - +% Syntax quick reference: Ledger # Syntax quick reference: Ledger + + [Big 3](index.html) | [Ledger](quickref-ledger.html) | [hledger](quickref-hledger.html) diff --git a/quickref/tests.shelltest b/src/quickref/tests.shelltest similarity index 100% rename from quickref/tests.shelltest rename to src/quickref/tests.shelltest