Easy way to compile markdown into scholarly documents, html or pdf
This project is meant to make writing easier and more productive.
So you want to write a document.
Maybe you'll share it on the web.
Maybe you want a polished pdf.
Maybe it's a blog, research paper, book draft, or just a set of notes.
You don't want to think about typesetting details.
You just want to throw your ideas in some plain text files and call make.
This is a starter template for using quarto, following the quarto Get Started. It seems to achieve a lot of what I was trying to do with my similar projects, markdown-memo and markdown-easy: make technical and scholarly writing easier and more productive.
This package makes it very easy to compile text taken in
Markdown
to valid xhtml or to a pdf via LaTeX.
It can be used to make static websites quickly,
for example (this site):
https://rreece.github.io/quarto-example/
This same document compiled to a pdf can be found here:
https://rreece.github.io/quarto-example/Quarto-Example.pdf
TODO
TODO
TODO
TODO
Just call
make
Just call
make pdf
Documentation:
- Finish Quick start in this README
- Better example of making plots through jupyter
- Make a table by reading csv?
Build:
- GitHub Actions for testing for build artifacts before deployment
- Change GitHub Actions to use this Makefile
- Conditionally build different parts of the document:
make html - Make pdf output-file configurable?
- Automatically get Makefile variables from
_quarto.yml - Make bibliography optional
- Makefile target for starting a new document
- Make it easy to create a small single page doc/webpage
- Support rendering a document from
./with no sub-directories?
Rendering issues:
- Issue with labeling equation in
alignfor pdf
Style:
- Add
_quarto.yamlsettings for custom css - Add
_quarto.yamlsettings for latex styling- Shrink fontsize for code
- Pollish book pdf output
- Config for making an article instead of a book
- Config for making an website instead of a book
- Template for article (e.g. NeurIPS)
Quarto links:
- quarto.org - Guide - Reference
- quarto example using math
- quarto using bibtex and CSL
- quarto doc about github-pages
- example
_quarto.yml - Quarto for Scientists
My projects:
Ryan Reece (@rreece)
Created: September 21, 2024