Check out markdown-memo with a simple git command, like:
git clone https://github.com/rreece/markdown-memo.git
Some basic instructions are given in the README.md. They are expanded on here.
Basically, once you have cloned markdown-memo, if you satisfy its requirements
you should be able to call make and receive reasonable html output,
and call make pdf and receive a reasonable pdf.
Feel free to rename markdown-memo as whatever is suitable to your project,
and delete the example *.md files.
- make
- LaTeX (texlive/mactex)
- python
- pandoc
- pandoc-citeproc
- pandoc-crossref
- matplotlib (for pagecount and wordcount plots)
- xpdf (pdfinfo command for pagecount)
First, if you are on a Mac, you should install
Xcode
through the Apple app store to get make and basic build utilities.
Then you should install homebrew
for package management1.
Some basic requirements I had to install with homebrew were the following, and I got pip and used it to install somethings:
brew install wget
brew install xpdf
sudo python get-pip.py
sudo pip install scipy
sudo pip install matplotlib
sudo pip install pandas
Then, with homebrew, the main packages to install are
brew cask install mactex
brew install pandoc
brew install pandoc-citeproc
brew install pandoc-crossref
Instead of homebrew, some years ago, I was using macports.
Using macports, I installed
sudo port selfupdate
sudo port install texlive-latex texlive-latex-recommended texlive-latex-extra texlive-math-extra
sudo port install pandoc
sudo port install hs-cabal-install
cabal update
cabal install pandoc-citeproc pandoc-crossref
If something doesn't work for you, please let me know! I'll do my best improve the documentation and make the software more robust as time allows. Contact me at:
Please let me know if you have success or failure testing this on different systems.
Just open or create a first md file in that directory like 01-introduction.md,
and start typing.
Each file should probably correspond to a webpage or section in the document,
and in that case, it should begin with an h1-level heading (section), denoted with
a double-rule of equal-signs, like:
Section title
===============================================================================
Or marked like this:
# Section title
Then you can have sub-sections as you wish, and/or just start typing the main text. There's no need for additional markup or html.
You can delete the example *.md files within this template
when beginning your project.
The following sections of this example document will show examples of Markdown syntax. For now, briefly, some examples of Markdown syntax are
Section 1
=================================
Sub-section 1
---------------------------------
[Lorem ipsum](https://en.wikipedia.org/wiki/Lorem_ipsum)
dolor sit amet, duo ut putant verear, nam ut brute utroque.
Officiis qualisque conceptam te duo, eu vim soluta numquam, has ut aliquip
accusamus. Probo aliquam pri id. Mutat singulis ad vis, eam euismod pertinax
an, ea tale volumus vel. At porro soleat est. Debet facilis admodum an sed,
at falli feugiat est.
1. one
1. two
1. three
You can do latex in-line, $e^{i\pi} + 1 = 0$, like that.
Or equations:
\begin{equation}
\int_{\partial\Omega} \omega = \int_{\Omega} \mathrm{d}\omega \,.
\end{equation}
In addition to writing the basic md files for your project, you need to write
a metadata file: meta.yaml. See the example metadata there.
Then you can build your document.
A lot of the inner-workings of markdown-memo are done in the Makefile.
- Call
makeormake htmlto generate valid xhtml. For example, this document. - Call
make pdfto generate a pdf document. For example, this document. - Call
make cleanto delete temporary LaTeX files. - Call
make realcleanto additionally delete the output html and pdf files.
I use an image of my email to hide it from text crawlers.
Please replace img/my-email.png with a screenshot of your
email address instead of mine,
or just remove the use of the image in meta.yaml.
Customize the files in templates/ to adjust the format
of the output html and pdfs files to your needs.