JuliaDocs/Documenter.jl

Julia syntax highlighting seems very limited

Open

#2,224 opened on Aug 20, 2023

View on GitHub
 (16 comments) (0 reactions) (0 assignees)Julia (910 stars) (513 forks)batch import
Format: HTMLType: Upstreamhelp wanted

Description

using Imbalance
using DataFrames
using StatsBase

probs = [0.5, 0.2, 0.3]                         
num_rows, num_cont_feats = 100, 5

X, y = generate_imbalanced_data(num_rows, num_cont_feats; 
                                probs, rng=42)                       
StatsBase.countmap(y)

# apply rose
Xover, yover = rose(X, y; s = 0.3, ratios = Dict(0=>1.0, 1=> 0.9, 2=>0.8), rng = 42)

Notice how markdown on Github colors the modules next to using and the function names. This isn't the case with any @example or @repr code I write using documenter.

Is there anyway to improve the syntax highlighting?

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-2 days
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
Basic JuliaDocumenter.jl usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate Documenter's current syntax highlighting implementation, likely in src/ or using highlight.js. Look at how @example blocks are processed and rendered. Check for any existing issues or PRs related to highlighting, and consider updating the highlighter configuration or adding a custom Julia lexer.