Skip to content

ihrke/markdown-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown-notes

Note-taking in markdown via LateX.

The source is written in markdown and translated to latex using pandoc and customized templates located in the templates folder. References are stored in references.bib in bibtex format.

The Makefile details how the translation works. If you are on linux, simply calling make in the parent directory will compile the report to a pdf-format if all dependencies are installed. Edit the variables in the Makefile to choose a template (located in ./templates).

Usage

  1. Install the dependencies

    sudo apt-get install pandoc pandoc-citeproc
    pip install pandoc-fignos
    
  2. Clone this repository

    git clone
    
  3. Edit Makefile to choose a template

  4. Write notes in notes.md (or add more .md files and put them into the Makefile), refs in references.bib, compile with make

NOTE: notes.md contains example code for tables, figures, equations, references and so on.

Recommended Editor/Tools

I think it works very nicely to write markdown-based papers in the atom editor. The following packages are useful:

  • autocomplete-bibtex

    Allows to get a drop-down list of references when writing @citation. However, it is currently necessary to put a global .bib file into the config file config.cson (see documentation):

    'autocomplete-bibtex':
      'references': [
        '/path/to/references.bib'
        '/path/to/references.json'
      ]
    
  • markdown-preview for nice syntax highlighting

  • pdf-view for viewing the PDF in Atom directly

Dependencies


Matthias Mittner matthias.mittner@uit.no

About

note-taking in markdown/latex

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published