lualogbook

A logbook template written in LuaTeX.

https://github.com/kvakil/lualogbook

Science Score: 31.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (6.3%) to scientific vocabulary

Keywords

lua lualatex moonscript notebook pandoc
Last synced: 4 months ago · JSON representation ·

Repository

A logbook template written in LuaTeX.

Basic Info
  • Host: GitHub
  • Owner: kvakil
  • License: mit
  • Language: MoonScript
  • Default Branch: master
  • Size: 77.1 KB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
lua lualatex moonscript notebook pandoc
Created over 8 years ago · Last pushed over 8 years ago
Metadata Files
Readme License Citation

README.md

logbook

A logbook using LuaLaTeX.

Installation

  1. Install Lua 5.1 and luarocks.
  2. Install MoonScript using luarocks.
  3. Install LuaLaTeX.
  4. Install latexmk.
  5. Install biber.
  6. Install pandoc.
  7. Install Python and pip.
  8. Install panflute using pip.
  9. Install git (optional: can remove from Makefile).

Daily Usage

  1. Use make today to add a template in YYYY/MM/DD.md and open in Sublime Text.
  2. Modify the above file.
  3. Use make to create log.pdf.
  4. git commit when done.

Other Files

  1. Use citations/citations.bib for citations.
  2. New includes should go on in document_setup.sty.
  3. New commands should go on in command_library.sty.
  4. Modify log.tex yearly: add includer.include_year("YYYY").
  5. Use make clean to clean everything up.

Likely Problems

  1. pandoc may require packages not present in document_setup.sty. If this happens, use --standalone and add the necessary lines under the pandoc header.
  2. latexmk being annoying: use latexmk -g

Technologies Used

  1. MoonScript: language which transpiles to Lua, except better.
  2. pandoc & panflute: handle the markdown to LaTeX conversion while ensuring the formatting and labels don't break.
  3. Makefile and latexmk: a rather precarious combination. All LaTeX compilation is handled by latexmk, and all pandoc things are handled by make.
  4. git: for version control.
  5. LuaLaTeX: the real engine, which runs the Lua files and compiles.

Owner

  • Name: Keyhan Vakil
  • Login: kvakil
  • Kind: user
  • Location: Berkeley, CA

personal account; opinions are my own and not my employer's.

Citation (citations/citations.bib)

@article{wombat2016,
    author   = {Walther Wombat and Klaus Koala},
    title    = {The true meaning of 42},
    journal  = {Journal of modern skepticism},
    date     = {2016},
    keywords = {trusted},
}

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels