Skip to content

Add markdown rendering #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

philipbutler
Copy link

@philipbutler philipbutler commented May 2, 2025

Resolves: #38
Allows simple markdown rendering. I am observing though that *s aren't rendering as bullets.

Before:
Screenshot 2025-05-02 at 1 16 30 PM

After:
Screenshot 2025-05-02 at 1 15 42 PM

@b9r5
Copy link
Collaborator

b9r5 commented May 3, 2025

Hey Phil - the visual diff looks really could. Could you check a couple of things:

  1. That links render as links - try both https://www.example.com and [example](https://www.example.com).
  2. That markdown rendering does not interfere with mathjax or vice versa - try some sample LaTeX like $$E=mc^2$$ along with some markdown.

Also please add a test to test_leaderboard.py that puts some markdown in the description, then scrapes the html with beautifulsoup and verifies that it contains the markdown rendered into HTML? (I hope that makes sense.) Test 1 above should be automated as pat of this.

I don't know of a way to automate test 2, so I guess it has to be manual for now, unless you can think of think of some way to automate it (but I wouldn't spend too much time on it if it's difficult - for example, screen scraping wouldn't be worth the effort.)

I still need to check over the diff to look at the content security policy.

Thanks!

@philipbutler
Copy link
Author

@b9r5 Yes that all makes sense! On it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support Markdown in leaderboard description box
2 participants