leanprover-community / leanprover-community/leanprover-community.github.io

`{{` cannot be used in markdown files

Open
#168 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
84
Forks
190
Avg merge
1d 12h
Merged PRs (30d)
12

Description

We're telling staticjinja that every .md file is a jinja2 template, so if one of them contains {{ (e.g. when talking about "weakly implicit" arguments in Lean, (usually written in unicode)), jinja2 will be unable to parse the file and then complain:

jinja2.exceptions.TemplateSyntaxError: unexpected char 'XX' at YY

This came up when testing templates/latex.md in #165.

Contributor guide

No contributing guide indexed for this repository

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

Read make_site.py around lines 399-421 and reproduce the failure with templates/latex.md, the file mentioned in the issue and #165. Determine how markdown files are passed to Jinja2; done means literal {{ text in a .md file no longer causes TemplateSyntaxError while normal templating still works.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.