StefanBartl/color_my_ascii.nvim

github

utility

7

0

0

0

CREATED

2025-12-11

UPDATED

2026-10-04

---

Beta stage — active development. This repository is past its first shape and in active use, but the surface is not frozen: breaking changes are still possible. Pin a commit or tag if you depend on it.

color_my_ascii.nvim

    ╔══════════════════════════════════════════╗
    ║   c o l o r _ m y _ a s c i i . n v i m   ║
    ║   ┌─┐ → ★ ┌─┐   function() end   ┌─┐      ║
    ╚══════════════════════════════════════════╝

Part of the wkd family — see this plugin's page on the site.

Colorful highlighting for ASCII art in Markdown code blocks, with automatic language detection, custom highlights and predefined color schemes — a fenced block full of box-drawing characters is, to every other tool, one undifferentiated grey wall; this one reads it and gives you a small literate-programming toolkit over the same blocks.

Around it

markdown.nvim — structures the document around the block (TOC, folding, tables); this one paints what is inside the block.

mdview.nvim — the one real consumer of the highlight read-back API: it repaints the same colors in a browser preview, so the rendered page and the buffer agree.

Both are soft: without them everything else works unchanged. lib.nvim is the one real dependency — see Requirements.

Documentation

Start at docs/README.md — what's where, and which question each page answers.

Getting started

• Requirements — Neovim version, the required lib.nvim dependency, and what's optional.
• Installation & Quickstart — plugin managers, the first coloured block, and typical configurations.

Reference

• Configuration — full setup() reference, treesitter integration, fence-line and fence-content highlighting.
• Commands — all user commands, the :Fence toolkit, and its configuration.
• Supported languages — the 31 built-in languages and standard fence-tag support.
• Fence API — public APIs for plugin authors: fenced-block detection, and reading back the applied highlighting.
• Color schemes — built-in schemes and how to create your own.
• Bindings cheatsheet — every command, keymap and autocommand in one table.

The rest

• What you get — the full capability catalog, grouped by theme: highlighting, languages, fences, schemes, tools.
• Integrations — the context-menu integration.
• Troubleshooting — what :checkhealth reports, performance notes, and common issues.
• Contributing — dev setup (stylua/luacheck/CI), adding a language or a character group.
• Tests — how to run the headless suite, what it covers, and the behaviour currently pinned as a known bug.
• Manual fixture — a Markdown file that exercises every feature by hand, with FIXTURE-CONFIG.md to turn them all on.
• Changelog — version history.
• Feedback — the issue tracker for bugs, features and usage questions; discussions for anything more open-ended.

:help color_my_ascii is the same reference inside the editor.

License

MIT — see LICENSE.