Yeoman generator for LaTeX documents
- Can combine LaTeX and markdown
- Can deal with
dot(graphviz) files via PDF files
- Can see the difference between two Git commits
Usage of a Created Project
The structure of the project as follows:
+--- [ProjectName].pdf # Generated PDF document +--- [ProjectName]-draft.pdf # Generated PDF document (show linenumber) +--- [ProjectName]-no-image.pdf # Generated PDF document (show linenumber and use draftmode) +--- diff.pdf # Difference between two Git commits +--- parameters.mk # Definition of the parameters +--- commands.mk # Commands and options used to compile +--- src/ | +--- preamble.tex # The tex file containing the preamble | +--- document.tex # The tex file containing the document | +--- documentclass.json # The information about documentclass | +--- doc/ | | +--- foo.tex # Tex file used in main.tex | | +--- bar.md # Markdown file can be used | +--- image/ | | +--- image1.png | | +--- image2.jpg | | +--- image3.pdf | | +--- image4.svg # svg files are converted to PDF files | +--- graphviz | | +--- graph.dot # The graphviz file | +--- html | | +--- image.html # The html file that is converted to pdf file | +--- bib | +--- ref.bib # The reference file +--- generated/ +--- scripts/ +--- makefile.d/ +--- Makefile
All files you write to make a document are contained in
src directory. The final outcomes (pdf files) are shown in the root directory.
Compile a Document
To build a document, run:
make # or make document or make all
Using Draft Mode
To build a document in draft mode, run:
Show a Difference of two Git commits
./pdf-diff.sh <old-commit> <new-commit> evince diff.pdf
Note: I think there are no bugs, but I recommend to run
git commitbefore running
pdf-diff.shoperates the revision graph of Git, so changes that are not committed may be erased.
To build a document automatically, run:
If you want to use the draft mode, run:
Yeoman and this generator1. Install
# 'sudo' may be required in some environments. npm install -g yo npm install -g generator-latex-with-markdown
2. Install the Depended Tools
Install the following tools:
The generator occurs an error if the depended tools are not installed.
3. Generate Your New Project
I tested this generator only in Linux, but I think that it works in OS X.
Getting To Know Yeoman
- Yeoman has a heart of gold.
- Yeoman is a person with feelings and opinions, but is very easy to work with.
- Yeoman can be too opinionated at times but is easily convinced not to be.
- Feel free to learn more about Yeoman.
MIT © Mikami Hiroaki