Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.65 KB

README.md

File metadata and controls

42 lines (24 loc) · 2.65 KB

criticmarkup-kate - A CriticMarkup syntax highlighter for Kate editor/KatePart

The XML file in this repository (criticmarkup.xml) contains rules for highlighting CriticMarkup syntax in Markdown files in Kate, the default text editor for KDE.

Once installed, opening any file with the .cmu or .critic extension should automatically highlight CriticMarkup syntax as in the example below:

CriticMarkup syntax highlighting screenshot

You can also manually select CriticMarkup syntax from the Tools > Highlighting menu in any normal Markdown file.

This highlighter works fine with Kate or Kwrite (which are both based on KatePart), and should also work with most of the common features of both CriticMarkup and Markdown.

Installation

Steps to install the CriticMarkup syntax highlighting file:

  1. Download the file criticmarkup.xml or clone this repository
  2. Find the folder ~/.kde/share/apps/katepart/syntax/ on your system (create it if it does not already exist)
  3. Move criticmarkup.xml into ~/.kde/share/apps/katepart/syntax/
  4. Open or restart Kate to use the syntax highlighter.

Default syntax highlighting files for Kate are usually stored in the folder /usr/share/kde4/apps/katepart/syntax/. However, custom syntax highlighters should probably be saved in the local syntax highlighting folder (~/.kde/share/apps/katepart/syntax/) in the user's home directory so that they don't get accidentally overwritten during an update.

NOTE: The above applies to KDE 4. If you are using Plasma 5, the local folder for Kate syntax files has changed to ~/.local/share/katepart5/syntax/.

Usage

Files with the extension .cmu or .critic will automatically be highlighted using the rules in criticmarkup.xml. Plain text or other files can be forced to use CriticMarkup highlighting rules by selecting CriticMarkup from the Highlighting menu:

  • Tools > Highlighting > Markup > CriticMarkup

Other Kate syntax highlighters

License

Based on kate-markdown by Claes Holmerson.

Inspired by CriticMarkup for Emacs by @joostkremers.

Dual-Licensed under both GPL and BSD licenses.