JuliaDocs/Franklin.jl

support code block name with whitespace

Open

#793 opened on Mar 5, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Julia (1,060 stars) (118 forks)batch import
code blocksgood first issue

Description

defining code blocks (file)names with ```julia:name breaks syntax highlighting, allowing whitespace like ```julia :name would fix it.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes allowing whitespace between the language name and the code block name in triple backtick fenced code blocks. The fix likely involves modifying the markdown parser in Franklin.jl to accept optional whitespace. Relevant files might include the parser or regex that extracts language and filename. Check the src/ directory for markdown parsing logic. The issue has been open since 2021 with 3 comments, so there may be some discussion on potential approaches.