Slider-Py

Parse a simplified MarkDown that is used to create my slides. (TODO make the format a subset of Markua)
Generate HTML files from the slides
Generate PDF from the slides
Generate mobi file from the slides

See the slide sources and the generated slides

Example

Create a directory (e.g. 'example') and in there a file called 'main.md' with the following content.

# Chapter Title
{id: page-url}
{i: subject matter}
{i: another!subject}

## Page Title
{id: page-url}

* Bullet
* Points


1. Numbered
1. Bullet
1. Points


   ```
   Verbatim for code between triple backticks.
   ```

Free Paragraph text.

**bold between a pair of double-stars**

`inline code example between single backticks`

HTML Links: [slides](https://code-maven.com/slides/) that will be used as links anywhere except in verbatim text

![Title](path/to/file.py)    # include external file
![](path/to/file.py)         # include external file use filename as title

![Title](path/to/file.png)    # include image


{aside}
In the asides, we support [links](http://some-page.com), **bold** and

* unordered
* list
{/aside}

Then run

python slider.py --md example/main.md --html --dir html/

The results shoule be in the 'html' directory.

TODO

Navigation key-binding in JavaScript (can be in other templating system)
make sure the same id does not exists in different pages
make sure index is not an id in the multiSlider case
make sure keywords is not an id
make sure examples is not an id
other conflicts?
Main page for multi-file case should be index.html
Next and Prev chapter link on the chapter pages.
To index of this chapter link on each page.
Numbering pages?
Keywords file extension link

Development suggestions:

Generate html slides in a temporary local directory to look at the result

rm -rf html/*; python slider/__init__.py --md cases/all.md --html --dir html

Update the expected results for a test case:

rm -rf cases/html/all
python slider/__init__.py --md cases/all.md --html --dir cases/html/all/

update all the test cases: ./update_test_cases

Development

virtualenv -p python3 venv
source venv/bin/activate
pip install -r dev-requirements.txt -c constraints.txt
pytest -v
pytest -v --cov=slider/ --cache-clear
flake8

Format

Chapter title and id:

Must be exactly one at the top of each .md file. The id will become the last part in the URL.

# Chapter
{id: chapter}

Page title, id, and words to index:

The id is required. It will become the last part of the URL.
There can be 0 or more {i: } entries. These are the words that are indexed and shown in the keywords table.

## Page title
{id: page-file-name}
{i: print}

szabgab / slider-py