A look at JohnSundell/Splash: 1.9k stars on GitHub, written primarily in Swift, tracked under the Mobile category. A fast, lightweight and flexible Swift syntax highlighter for blogs, tools and fun!
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Welcome to Splash - a fast, lightweight and flexible Swift syntax highlighter. It can be used to generate code sample HTML for a blog post, to turn a string of Swift code into a fully syntax highlighted image, or to build custom developer tools.
It's used to highlight all articles on swiftbysundell.com.
Usage
Splash can be used either as a library in your own Swift Package Manager-powered tool or script, or by using one of the four built-in command line tools that act as frontends for the Splash library.
🌍 On the web
If you're using Publish, then there's an official plugin that makes it easy to integrate Splash into your website:
👉 SplashPublishPlugin
If you're using Jekyll, there's also a custom {% splash %} tag available for the Liquid templating language.
👉 splashtag
🖥 On the command line
The easiest way to get started building things with Splash is to use one of the four built-in command line tools that each enable you to use Splash in different ways.
SplashHTMLGen
SplashHTMLGen uses Splash's HTML output format to generate an HTML string from Swift code. You simply pass it the code you want to highlight as an argument and HTML is returned as standard output.
To be as flexible as possible, Splash doesn't hardcode any colors or other CSS attributes in the HTML it generates. Instead it simply assigns a CSS class to each token. For an example of a CSS file that can be used to style Splash-generated HTML, see Examples/sundellsColors.css.
When rendering your outputted html, make sure to wrap your output code in the <pre> and <code> tags and properly link to your .css file. Like this:
For more information about HTML generation with Splash and how to customize it, see HTMLOutputFormat here.
SplashMarkdown
SplashMarkdown builds on top of SplashHTMLGen to enable easy Splash decoration of any Markdown file. Pass it a path to a Markdown file, and it will iterate through all code blocks within that file and convert them into Splash-highlighted HTML.
Just like the HTML generated by SplashHTMLGen itself, a CSS file should also be added to any page serving the processed Markdown, since Splash only adds CSS classes to tokens — rather than hardcoding styles inline. See the above SplashHTMLGen documentation for more information.
Here’s an example call to decorate a Markdown file at the path ~/Documents/Article.md:
$ SplashMarkdown ~/Documents/Article.md
The decorated Markdown will be returned as standard output.
Highlighting can be skipped for any code block by adding no-highlight next to the block’s opening row of backticks — like this: “```no-highlight”.
SplashImageGen
SplashImageGen uses Splash to generate an NSAttributedString from Swift code, then draws that attributed string into a graphics context to turn it into an image, which is then written to disk.
The following image will be generated (and written to disk as MyImage.png):
SplashImageGen is currently only available on macOS.
SplashTokenizer
The final built-in command line tool, SplashTokenizer, is mostly useful as a debugging tool when working on Splash - but can also be interesting to use in order to see how Splash breaks down code into tokens. Given a string of Swift code, it simply outputs all of its components (excluding whitespaces).
Keyword token: func
Plain text: hello(world:
Type token: String
Plain text: )
Plain text: ->
Type token: Int
📦 As a package
To include Splash in your own script or Swift package, add it as a dependency and use the SyntaxHighlighter class combined with your output format of choice to highlight a string of code:
import Splash
let highlighter = SyntaxHighlighter(format: HTMLOutputFormat())
let html = highlighter.highlight("func hello() -> String")
Splash ships with two built-in output formats - HTML and NSAttributedString, but you can also easily add your own by implementing the OutputFormat protocol.
Installation
Splash is distributed as a Swift package, making it easy to install for use in scripts, developer tools, server-side applications, or to use its built-in command line tools.
Splash supports both macOS and Linux.
Before you begin, make sure that you have a Swift 5.2-compatible toolchain installed (for example Xcode 11.5 or later if you're on a Mac).
📦 As a package
To install Splash for use in a Swift Package Manager-powered tool or server-side application, add Splash as a dependency to your Package.swift file. For more information, please see the Swift Package Manager documentation.
Splash is developed completely in the open, and your contributions are more than welcome. It's still a very new project, so I'm sure there are bugs to be found and improvements to be made - and hopefully we can work on those together as a community.
This project does not come with GitHub Issues-based support, and users are instead encouraged to become active participants in its continued development — by fixing any bugs that they encounter, or by improving the documentation wherever it's found to be lacking.
To read more about suggested workflows when contributing to Splash, how to report bugs and feature requests, as well as technical details and an architectural overview - check out the Contributing Guide.
Hope you enjoy using Splash!
I had a lot of fun building Splash, and I'm looking forward to continue working on it in the open together with you! I hope you'll like it and that you'll find it useful. Let me know what you think on Twitter 😊
How does JohnSundell/Splash compare to other Mobile projects?
JohnSundell/Splash is tracked by TopGit in the Mobile category, with 1.9k GitHub stars and written in Swift. Browse the Mobile topic page on TopGit to compare it against similar projects by stars and activity.
Is JohnSundell/Splash open source?
Yes — JohnSundell/Splash ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/JohnSundell/Splash.
What else is in the Mobile space?
JohnSundell/Splash is tracked by TopGit under the Mobile category, alongside 4 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What is JohnSundell/Splash?
JohnSundell/Splash (JohnSundell/Splash) is a Swift project on GitHub. From the project's own README: A fast, lightweight and flexible Swift syntax highlighter for blogs, tools and fun!
Where do I read more about JohnSundell/Splash?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/JohnSundell/Splash is the definitive source.
Why is JohnSundell/Splash categorized under Mobile?
TopGit places JohnSundell/Splash in the Mobile category based on its GitHub topics and description (tagged: "command-line-tool", "swift", "swift-package"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Curious whether Splash is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about Splash.