Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 3.68 KB

README.md

File metadata and controls

66 lines (54 loc) · 3.68 KB

Minimal-DOC

Minimal template for typesetting a report (REP) and a presentation (PRE) in LaTeX.

Showcase

The files Minimal-REP.tex and Minimal-PRE.tex contain, respectively, a sample report and presentation typeset using my Minimal theme.

Sample report

Title page Sample page

Sample presentation

Title slide Sample slide

Usage

To build a pdf version of the report and the presentation simply run the following commands (assuming you have both pdflatex and bibtex installed for instance from a MiKTeX distribution):

git clone https://github.com/FMatti/Minimal-DOC.git
cd Minimal-DOC
pdflatex Minimal-REP.tex && bibtex Minimal-REP.aux && pdflatex Minimal-REP.tex && pdflatex Minimal-REP.tex
pdflatex Minimal-PRE.tex && bibtex Minimal-PRE.aux && pdflatex Minimal-PRE.tex && pdflatex Minimal-PRE.tex

Filestructure

Minimal-DOC
│  
│   README.md
|   LICENSE
│   Minimal-REP.tex         (sample report)
│   Minimal-PRE.tex         (sample presentation)
│   biblio.bib              (bibtex bibliography file)
|
└───minimal
|   |
|   |   stylesheet.sty      (style file for reports)
|   |   beamertheme.sty     (style file for presentation)

Becoming a VSCode poweruser...

  1. If not already done, install VSCode.
  2. If not already done, install a LaTeX distribution (e.g. MiKTeX).
  3. In VSCode go to the Extensions tab (press ctrl + shift + x), search for LaTeX Workshop, and install this extension.
  4. Go to File > Preferences > Configure User Snippets > latex and insert the contents of this snippet into the latex.json file that you have just opened. You have now access to a variety of code snippets which will be prompted once you type a \ character in a .tex document.
  5. Press ctrl + shift + p to open the command palette. Type Preferences: Open User Settings (JSON) and press enter. In the settings.json file then navigate to the variable "latex-workshop.latex.recipes" and add a the following recipe below any previously defined recipes:
{
    "name": "pdflatex ➞ bibtex ➞ pdflatex × 2",
    "tools": ["pdflatex", "bibtex", "pdflatex", "pdflatex"]
},
  1. In VSCode open a .tex file and press ctrl + shift + p to open the command palette. Type LaTeX Workshop: Build with recipe, select the recipe named pdflatex ➞ bibtex ➞ pdflatex × 2 and execute it.
  2. To view the generated .pdf file, press ctrl + shift + p to open the command palette, type LaTeX Workshop: View LaTeX PDF in VSCode tab and press enter.

After each time you make changes to the .tex file, you can partially recompile the file by pressing ctrl + s to see the changes applied to the .pdf (if you do any changes to the bibliography, you will need to follow the full compilation instructions in point 6.)

Closing words

This theme is dedicated to two truly amazing friends of mine.