]> git.xolatile.top Git - public-libhl.git/commitdiff
fixed syntax
authoranon <anon@anon.anon>
Sat, 19 Aug 2023 18:54:59 +0000 (20:54 +0200)
committeranon <anon@anon.anon>
Sat, 19 Aug 2023 18:54:59 +0000 (20:54 +0200)
README.md

index 69d8a251c274c5a2c019252dbfbbce80177a1252..45d7fb6648af576932f190657b840c1279911f9c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -41,6 +41,7 @@ This is how you append a display mode that render_string() will search based on
                REGION
        } token_type_t;
 These are the valid type of distinct token types.
+
        KEYSYMBOL - a string which is contextless, the surounding text is ignored
                     "mysymbol" will match inside all of these:
                         "something mysymbol something"
@@ -50,11 +51,17 @@ These are the valid type of distinct token types.
        KEYWORD   - a string which is recognized when surounded by word bundaries such as ' ' or '\t'
        MATCH     - a Vim style regular expression to be recognized
        REGION    - a Vim style regular expression where the starting and ending patters are to be distinguished from the contents
+
 The universal way to add a new pattern to be recognized is with:
+
        token * new_token(const char * const syntax, const token_type_t t, const hl_group_t * const g);
+
 This wraps one of the following:
+
        // ?!
+
 There are also convinience functions:
+
        // NOTE: the return value is the number tokens successfully inserted
        int new_keyword_tokens(const char * const * words, hl_group_t * const g);
        int new_syntax_character_tokens(const char * const chars, hl_group_t * const g);
@@ -63,10 +70,13 @@ There are also convinience functions:
 hl can parse a small subset of VimScript: the few instructions related to highlighing, and it ignores everything else.
 All Vim highlighing scripts should be valid hl scripts.
 The instrunctions in particular are:
+
        sy[ntax] keyword <hl_group> <word>+
        sy[ntax] match   <hl_group> <regex>
        sy[ntax] region  <hl_group> start=<string|match> end=<string|match>
        hi[ghtlight] link <from_group> <to_group>
        hi[ghtlight] def  <group> <display_t>=<data>+
+
 Additionally hl recognizes:
+
        syn[ntax] keysymbol <char>+