Skip to content

Latest commit

 

History

History
77 lines (62 loc) · 1.67 KB

README.md

File metadata and controls

77 lines (62 loc) · 1.67 KB
Raw

Contra

The Contra utility converts the so called "C Style Markup Language" to HTML/XML and back. The primary aim is to maximize both editability and readability by dynamizing the markup representation.

The Contra utility itself is meant to serve as a backbone for other tools, such as text editor or IDE extensions.

See documentation/* for the exact details or follow this README for a quick-start.

Example

demo

If someone is used to writing *script, this should be more comfortable to type out:

p {
    foo br;
    bar br;
}

And press Alt + Shift + C (in VScode), then to type out this with:

<p>
    foo <br/>
    bar <br/>
</p>

Yet, the two are equivalent using Contra.

Installantion

For any of the below plugins to work, the Contra executable will have to be installed on your system.

Build from source

Contra is written in C++, it must be compiled.

Make sure you have the following compile time dependencies:

  • a C++ compiler (e.g. g++)
  • Make (e.g. GNU Make)
  • Flex

After navigating to the root directory, run:

$ make

This will result in a new executable file called contra, place it in your $PATH. The easiest way to do so is by running:

$ make install

Vim

Place the file "plugin/contra.vim" inside "~/.vim/plugin/". You might have to create the directory yourself. Or, assuming your setup actually matches with the above, you could run:

$ make vim_install

Visual Studio Code

The VS Code extension is written in TypeScript, so it has to be compiled too. This will require a million node modules. You are advised to run:

$ make code_install