Simulation-Software-Engineering / Simulation-Software-Engineering/Lecture-Material

Create pandoc template that approximates HedgeDoc formatting

Open
#39 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue part:documentation
Dominant language
Python
Stars
63
Forks
70
Avg merge
8d 18h
Merged PRs (30d)
1

Description

We should set up a pandoc template for our slides such that the formatting of HedgeDoc (reveal.js) is approximated. It is not that much about the coloring, but the font sizes and margins of the slides. This especially concerns the formatting of code blocks since the code blocks tend to be too large on most slides generated by pandoc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names Pandoc slides, HedgeDoc/reveal.js formatting, font sizes, margins, and oversized code blocks, but no repository files or tests. Start by locating the existing slide-generation entry point and compare its output with HedgeDoc; done means a Pandoc template approximates the slide spacing and typography, especially making code blocks fit better.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.