README.asciidoc

== Highlight for Asciidoc

This repository has highlight configurations of AsciiDoc language for text editors:

• Notepad++
• gedit

• link:CONTRIBUTING.md[How to contribute]

=== Notepad++

This is a simple highlight for Notepad++.

NOTE: There is a video that shows how to install: http://www.youtube.com/watch?v=_i-KxSb7cJM

==== How to install Download and save the file https://github.com/edusantana/asciidoc-highlight/raw/master/notepad%2B%2B/userDefineLang.xml[notepad++/userDefineLang.xml]

Go to Notepad++ menu "Language/Define your language" and import that file.

CAUTION: If you are using the Notepad++ in portugese, it has a translation error: The Import and Export button are switched.

How to create Syntax Highlighting::

• http://sourceforge.net/apps/mediawiki/notepad-plus/index.php?title=User_Defined_Languages
• http://sourceforge.net/apps/mediawiki/notepad-plus/index.php?title=Category:Syntax_Highlighting
• http://udl20.weebly.com

=== gedit

This file was originaly downloaded from https://launchpad.net/asciidoc-gtk-highlight But I'm creating new versions here on github.

The content of https://github.com/edusantana/asciidoc-highlight/blob/master/gedit/asciidoc.lang[gedit/asciidoc.lang] will be submited to https://gitlab.gnome.org/GNOME/gtksourceview/tree/master/data/language-specs[GNOME/gtksourceview] so it can come at default installation.

==== How to install

===== Cloning repository

.Clone repository

cd YOURDIR git clone https://github.com/edusantana/asciidoc-highlight

.Run install script

cd YOURDIR/asciidoc-highlight/gedit/ ./install.sh

NOTE: I recommend this method because you can keep updating from repository:

.Getting updates

cd asciidoc-highlight git pull

===== Without cloning

.GtkSourceView version 4

mkdir -p ~/.local/share/gtksourceview-4/language-specs/ cd ~/.local/share/gtksourceview-4/language-specs/ wget https://raw.github.com/edusantana/asciidoc-highlight/master/gedit/asciidoc.lang

.GtkSourceView version 3

mkdir -p ~/.local/share/gtksourceview-3.0/language-specs/ cd ~/.local/share/gtksourceview-3.0/language-specs/ wget https://raw.github.com/edusantana/asciidoc-highlight/master/gedit/asciidoc.lang

For system-wide installation, use the /usr/share/gtksourceview-3.0/language-specs/ directory instead.

.GtkSourceView version 2

mkdir -p ~/.local/share/gtksourceview-2.0/language-specs/; cd ~/.local/share/gtksourceview-2.0/language-specs/ wget https://raw.github.com/edusantana/asciidoc-highlight/master/gedit/asciidoc.lang

== Testing installation

---

wget https://github.com/edusantana/asciidoc-highlight/raw/master/test/TESTME.adoc gedit TESTME.adoc

image::https://user-images.githubusercontent.com/3603111/31322651-2d94005e-ac72-11e7-81fe-29faf6745a79.png[]

NOTE: `TESTME is not an asciidoc tag, I made it up just to test your installation.

==== How to customize

https://developer.gnome.org/gtksourceview/stable/ https://developer.gnome.org/gtksourceview/stable/ch02.html

=== Follow the repository to get updates

Remember to follow the repository to be notified of updates.