https://github.com/jborrow/lectures-in-the-middle
Online lecture notes system for .tex files built with middleman.
https://github.com/jborrow/lectures-in-the-middle
Last synced: 3 months ago
JSON representation
Online lecture notes system for .tex files built with middleman.
- Host: GitHub
- URL: https://github.com/jborrow/lectures-in-the-middle
- Owner: JBorrow
- Created: 2016-10-12T13:48:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-23T15:08:48.000Z (about 7 years ago)
- Last Synced: 2024-12-27T06:41:35.491Z (5 months ago)
- Language: HTML
- Size: 11.2 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Lectures in the Middle
======================
A statically compiled, online lecture note system.
Concerned that your lecture notes are being left to die in the hole that
is .pdf documents? Want to increase engagement, and ensure that content
is presented in the correct format for all devices? Want a full-text
search that includes your LaTeX math?
Then, boy, do we have the system for you!
This system takes a .tex file (or several of them), and compiles it to a
fancy-looking lecture notes website, like the one available at
< > (Lectures in the Middle was built for this). Just stick in some
of our custom syntax to define where lectures start and the sections you
want the compiler to pick up (as well as keypoints) and you're ready to
go!
Why Middleman?
--------------
University webservers completely suck. Why worry about them, their old,
decrepit PHP & MySQL installations, when you can just pre-compile your
website to html?
We chose middleman because it has fantastic documentation and is very
'back-to-basics' -- it just gave us what we needed.
Dependencies
------------
- ``` pandoc ```
- ``` pandoc-crossref, pandoc-citeproc ``` (install using ```cabal```)
- ``` ruby ``` and ``` bundle ```
- ``` python 3 ```
- The helper module, ``` ltmd ```
Why so many dependencies? For a system like this, it's best if it's fit-
and-forget. That's why we used as many external tools as possible -- the
rest is just short scripts that plug everything together.
Custom Syntax
-------------
These snippets should be placed in your LaTeX code:
- ```%%\lecture{}``` to denote the start of the lecture
- ```%%\section{}``` to denote the start of the section
- ```%%\keypoint{}``` to denote a keypoint.
Usage
-----
Simply put your lecture note .tex files into ```/texfiles```, your images
into ```/web/images/```, and then run the ```compile.py``` script, using
```python3```.
This will, if run with the ```--pdflatex``` flag, also compile your
documents to .pdf files using pdflatex.
### Initial Usage
Initially, you will need to run ```bundle install``` to install the
required ruby dependencies.
Great, but, shouldn't this be in Ruby?
--------------------------------------
Yes.