openedx / openedx/xblock-sdk

Code formatting in Markdown

Open
#215 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
70
Forks
104
Avg merge
17h 46m
Merged PRs (30d)
14

Description

Currently, when creating an Xblock we have some basic markdown support such as using square brackets for creating a checkable list. However, we do not seem to have full markdown support. When creating an Xblock using the code formatter ticks '`', tries to create an algebraic formula rather than work as a code formmater.

We should fully support markdown in the Xblocks to enable staff to create a wide range of problems.

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

Start by finding the XBlock code that handles square-bracket checklists and backtick formatting, then compare its current behavior with the requested Markdown support. Define which Markdown syntax must work and how it will be verified; the issue names no files, tests, or acceptance criteria, so its scope needs maintainer clarification.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
content
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.