first working example

README.md

@@ -1,2 +1,46 @@
 # quarto_titlepages
-A repo with templates for title pages. Currently just PDF.
+
+This template makes a custom title page. It only works with `scrbook` and `srcartcl` document classes at the moment. Some of the title pages are inspired from [Latex Templates](http://www.latextemplates.com/cat/title-pages#google_vignette).
+
+## How it works
+
+-   Defines titlepage (scrartcl) or frontmatter (scrbook) via a pandoc template in `partials/<name>/before-body.tex`.
+-   Passes that template in via `template-partials`. This is needed so that you can reference the YAML variables, things like `author`.
+-   Specifies the extra things (packages) that are needed for the LaTeX header in `partials/in-header.tex`.
+
+## The YAML
+
+    format:
+      pdf:
+        documentclass: scrartcl 
+        number-sections: true
+        template-partials: ["partials/vline_article/before-body.tex"]
+        include-in-header: 
+          - partials/vline_book/in-header.tex
+        toc: true
+        lof: true
+        lot: true
+
+What is going on:
+
+LaTeX document class affects the look; For now just `scrartcl` or `srcbook`
+
+        documentclass: scrartcl
+
+Articles generally don't have `#` (header 1) but instead just use `##` (header 2). If you use, `#` (header 1) in `scrartcl`, then you need to set
+
+        number-sections: true 
+
+so the numbering isn't whack.
+
+This is the custom title page stuff. Change the directory to the titlepage you want. So like change `vline_article` to `vline_book`. You need to match `scrartcl` to `vline_article` and `scrbook` to `vline_book`.
+
+        template-partials: ["partials/vline_article/before-body.tex"]
+        include-in-header: 
+          - partials/vline_book/in-header.tex
+
+Next bit indicates if you want table of contents (toc), list of fig (lof), or list of tables (lot).
+
+        toc: true
+        lof: true
+        lot: true