# How to highlight REPL examples in (GitHub) README.md

**URL:** https://discourse.julialang.org/t/how-to-highlight-repl-examples-in-github-readme-md/112943
**Category:** Tooling
**Tags:** github, markdown
**Created:** [April 15, 2024, 3:02am UTC](https://discourse.julialang.org/t/how-to-highlight-repl-examples-in-github-readme-md/112943 "2024-04-15T03:02:17Z")
**Posts on this page:** 2
**Page:** 1

<div class="post-metadata">

### Author: ![Abhro](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/abhro/32/220753_2.png) [@Abhro](https://discourse.julialang.org/u/Abhro)
#### Post date: [April 15, 2024, 3:02am UTC](https://discourse.julialang.org/t/how-to-highlight-repl-examples-in-github-readme-md/112943/1 "2024-04-15T03:02:17Z")

</div>

I’m trying to highlight REPL examples in a standalone README.md file. How do I hint to GitHub that this should be stylized as a Julia REPL session? I know that standard Julia can be highlighted using the ````julia```` tag. Julia base suggests using ````julia-repl```` ([Documentation · The Julia Language](https://docs.julialang.org/en/v1/manual/documentation/#Writing-Documentation)) and Documenter.jl uses ````jldoctest````, but I’m looking for something that works on GitHub’s default viewer. Using the basic ````julia```` tags does work to some extent, but it clashes with the REPL prompt and makes it harder to understand what’s code and what’s output at first glance.

 ![image](https://global.discourse-cdn.com/julialang/original/3X/d/7/d7f1335c614992cf10d8e8768dd98d635f9814f3.png)  
Image showing GitHub highlighting Julia code using ````julia [...]````

 ![image](https://global.discourse-cdn.com/julialang/original/3X/a/4/a4866325ea44d93c3dd3e04beb81f712914c83e1.png)  
Example with Documenter.jl (and ````jldoctest```` AFAICT? (which is not supported by GitHub either))

---

<div class="post-metadata">

### Author: ![gbruer](https://avatars.discourse-cdn.com/v4/letter/g/eb8c5e/32.png) [@gbruer](https://discourse.julialang.org/u/gbruer)
#### Post date: [July 23, 2024, 5:01pm UTC](https://discourse.julialang.org/t/how-to-highlight-repl-examples-in-github-readme-md/112943/2 "2024-07-23T17:01:00Z")

</div>

I was also interested in this and found some information. It seems that `julia-repl` does syntax highlighting on the code lines but not the output or prompt.

Github’s list of languages supported for syntax highlighting is documented here: [linguist/vendor at 39fd5e93de98de3434cb3e857c5b1972c418f8c5 · github-linguist/linguist · GitHub](https://github.com/github-linguist/linguist/tree/39fd5e93de98de3434cb3e857c5b1972c418f8c5/vendor)

There is an open issue and draft PR to update add the prompt hightlighting:

- [Highlight prompts in REPL syntax highlighting · Issue #283 · JuliaEditorSupport/atom-language-julia · GitHub](https://github.com/JuliaEditorSupport/atom-language-julia/issues/283)
- [update regex to support multiline in julia-console by Pangoraw · Pull Request #285 · JuliaEditorSupport/atom-language-julia · GitHub](https://github.com/JuliaEditorSupport/atom-language-julia/pull/285)
