https://github.com/jborrow/projection

A custom sytnax parser for LaTeX -> Markdown conversion. Very much indev. Probably don't try to use this in production.
https://github.com/jborrow/projection

Last synced: 3 months ago
JSON representation

A custom sytnax parser for LaTeX -> Markdown conversion. Very much indev. Probably don't try to use this in production.

• Host: GitHub
• URL: https://github.com/jborrow/projection
• Owner: JBorrow
• Created: 2018-01-06T18:29:15.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-20T21:13:17.000Z (over 7 years ago)
• Last Synced: 2024-12-27T06:41:34.017Z (5 months ago)
• Language: Python
• Size: 33.2 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Projection

==========

A parser for lecture notes (and other TeX documents) using custom syntax

to go from TeX to an HTML website via Markdown, thanks to Pandoc.

Your document will be parsed to a SQLite database, and this will then

be passed to the frontend code that turns it into a website.

You can define your own templates in `frontend/template`.

Requirements

------------

Due to some constraints on how dictionaries are used, `projection` requires

python3.6.0 (CPython) or above.

The python requirements are available in `requirements.txt` and may be

installed through `pip install -r requirements.txt`.

You will also need `pandoc` and the pandoc requirements from `ltmd`, which

unfortunately on most machines will require installation from source.

What?

-----

`projection` allows you to define three types of custom syntax:

### Sections

These sections will be broken up into different HTML documents, and can be

overlapping. One example use could be a set of 'sections' in a document,

and a set of 'lectures' over which they were covered. These might not

always be the same thing!

### Collectors

These are things that need to be 'picked up' throughout the document and

associated with the above 'Sections'. An example could be keypoints in a 

set of lecture notes. These can then be dynamically displayed on each

relevant page.

### Removals

These are items that need to be removed from the HTML output. Examples

might include things like LaTeX positioning commands for images.

Parameter File

--------------

To run `projection`, you will need to specify a parameterfile, which is

written in the `YAML` structured text format.

```yaml

meta:

  title: "Hello World"  # Title of your website

  author: "Author"  # Your name!

  database: "example.db"  # Name of your databse

sections:

  - name: "Sections"  # Name of this section (needs to be unique) to

                      # display on the website.

    syntax: "section"  # The custom syntax you wish to use to denote

                       # a new section. This corresponds to

                       #    %%\section{name_of_section}.

    level: 1           # Heading level. Use 0 to not display.

collectors:

  - name: "Keypoints"  # The name of the section of collectors to display

    syntax: "keypoint" # The custom syntax -- this corresponds to

                       #    %%\keypoint{keypoint_text}.

removals:

  - name: "PDFONLY"  # Name, this is arbritary.

    syntax:

      start: "beginpdfonly"  # Start syntax (%%\beginpdfonly)

      end: "endpdfonly"      # End syntax.  (%%\endpdfonly)

```

You can define as many of these with as many names as you wish!