Making cgit Pretty
Previously I wrote about how to install and configure cgit on Debian. If you have followed that short guide you now have a kick ass cgit install running on your server. So whats next? A bare cgit installation is pretty dull and there are some neat built in features that should be enabled for an optimal user experience. Open up /etc/cgitrc and made the following additions.
Configure Default README
You can set the default README for all repos by adding the following line.readme=master:README.md
This will tell cgit to look for the README.md file in your master branch for the default README for a given project.
Add an about filter
You can add an about filter which will add the about tab to your projects and display the README file configured in the previous step.about-filter=/usr/lib/cgit/filters/about-formatting.sh
Assuming that you have a README.md file in your master branch you will now see it in the about tab of your project.
Enable Syntax Highlighting
This is a no brainer. Adding syntax highlighting makes your code easier to look at on the website. This takes a few steps. First install the highlight package withsudo apt-get install highlight
. Next, open up/usr/lib/cgit/filters/syntax-highlighting.sh
and uncomment the last line that reads exec highlight --force -f -I -O xhtml -S "$EXTENSION" 2>/dev/null
Next, open up your stylesheet which should be found inusr/share/cgit/cgit.css
and add the following sections.
# Style definition file generated by highlight 2.4.8, http://www.andre-simon.de/ table.blob .num { color:#2928ff; } table.blob .esc { color:#ff00ff; } table.blob .str { color:#ff0000; } table.blob .dstr { color:#818100; } table.blob .slc { color:#838183; font-style:italic; } table.blob .com { color:#838183; font-style:italic; } table.blob .dir { color:#008200; } table.blob .sym { color:#000000; } table.blob .kwa { color:#000000; font-weight:bold; } table.blob .kwb { color:#830000; } table.blob .kwc { color:#000000; font-weight:bold; } table.blob .kwd { color:#010181; }# Style definition file generated by highlight 3.13, http://www.andre-simon.de/
body.hl { background-color:#e0eaee; } pre.hl { color:#000000; background-color:#e0eaee; font-size:10pt; font-family:‘Courier New’,monospace;} .hl.num { color:#b07e00; } .hl.esc { color:#ff00ff; } .hl.str { color:#bf0303; } .hl.pps { color:#818100; } .hl.slc { color:#838183; font-style:italic; } .hl.com { color:#838183; font-style:italic; } .hl.ppc { color:#008200; } .hl.opt { color:#000000; } .hl.ipl { color:#0057ae; } .hl.lin { color:#555555; } .hl.kwa { color:#000000; font-weight:bold; } .hl.kwb { color:#0057ae; } .hl.kwc { color:#000000; font-weight:bold; } .hl.kwd { color:#010181; }
source-filter=/usr/lib/cgit/filters/syntax-highlighting.sh
repo.url=my-repo repo.path=/srv/git/my-repo.git repo.readme=master:README.rst repo.about-filter=/usr/lib/cgit/filters/about-formatting.sh repo.desc=The best repo ever repo.owner=Your Name
Thank you for reading! Share your thoughts with me on bluesky, mastodon, or via email.
Check out some more stuff to read down below.
Most popular posts this month
- 2024
- Reinstalling Windows at 1am
- SQLite DB Migrations with PRAGMA user_version
- My Custom Miniflux CSS Theme
- How to Disable Wayland in Debian Testing
Recent Favorite Blog Posts
This is a collection of the last 8 posts that I bookmarked.
- Underused Techniques for Effective Emails from Refactoring English
- Death by a thousand slops from daniel.haxx.se
- The AGI economy is coming faster than you think from Freethink
- Rolling the ladder up behind us from Xe Iaso's blog
- In Praise of “Normal” Engineers from charity.wtf
- Reports of Bluesky's death have been greatly exaggerated from The Torment Nexus
- What Would a Kubernetes 2.0 Look Like from matduggan.com
- We Can Just Measure Things from Armin Ronacher's Thoughts and Writings
Articles from blogs I follow around the net
One Year of Lifting Weights
We visited Portugal last year. I still remember how heavy the luggage felt that we had with us: 2 suitcases, weighing around 20 kg each. One year later, I now joke about that, and laugh, whenever I tell anyone about it. I didn’t think much of it at the tim…
via ttntm.me - Blog August 1, 2025Secret Cinema - Grease
I was lucky enough to score tickets to last-night's dress rehearsal. It would be unfair to review this like a completed show, instead this is a preview on what to expect and some thoughts on the "immersive" genre. Very mild spoilers ahead. …
via Terence Eden’s Blog August 1, 2025P&B: Emma Goto
This is the 101st edition of People and Blogs, the series where I ask interesting people to talk about themselves and their blogs. Today we have Emma Goto and her blog, emgoto.com To follow this series subscribe to the newsletter. A new int…
via Manuel Moreale August 1, 2025Generated by openring