chore: move from "master" → "main"

feat: add support for `@header` and `@image` annotations

Ignore release archives

Prepare for 1.0 release

doc: regen with current docvim

Add empty .watchmanconfig

Allows a Watchman instance configured with `enforce_root_files` to watch
this directory even if `root_files` does not contain any of the files in
the directory. (Necessary to get around undesired corporate
`/etc/watchman.json` config.)

Ignore tags file

Add documentation generated by docvim

Now the circle is complete.

Remove stray references to Pinnacle repo

These due to COPY-PASTA.

Work around "after" directory not being in the 'runtimepath'

Fix annoying error messages on switching to a new *.vim file

This will happen because the file gets re-evaluated (almost?) every time
you switch to a *.vim file after having looked at another filetype.

Update docs

- Add missing heading.
- List all mirrors.
- Use subheadings in version history.

Depend on Pinnacle, optionally, instead of on my dotfiles

Italicize all the things

Comments are usually italics, so these should be too.

Note that I can't actually ship this as it depends on
`functions#italicize_group`, which is only defined in my dot files, but
I will eventually extract that too into a separate plug-in so that I can
re-use it here too.

Avoid "Ignore" highlight group

It's too hard to read.

Update links

Including a link to the not-yet-existent Hackage package.

docs: Edit for nuance

Switch to MIT license

Just to keep it the same as the license we're using for Docvim itself.

Add @commands, @functions, @options

For the same reason that @mappings is useful, we want a way to
supplement the auto-generated COMMANDS, FUNCTIONS and OPTIONS sections
with arbitrary additional info.

For now this info will get appended to the section, but in the future I
might look at providing nested @header and @footer annotations to allow
you to force it to one location of the other; eg:

  @commands

  @header

  Stuff that gets prepended to the COMMANDS section.

  @footer

  Stuff that gets appended to the COMMANDS section.

Allow docvim blocks to appear inside function bodies

For example, I just had a case where I had an option defined/used inside
a function:

  function s:foo()
    ""
    " @option g:SomeOption boolean 1
    "
    " This option does some thing.
    let l:dispatch=get(g:, 'SomeOption', 1)

    " [code that uses the option here...]
  endfunction

Note that @option is a bit different from @mapping and @command. The
latter generally will have one authoritative place where they are
defined and where their documentation can logically/obviously go. An
@option on the other hand, may be used in multiple places.

So it may make sense to either just document these elsewhere (like up in
the @plugin area), or get into the habit of making a centralized place
where option default values are defined, so that they can be documented
independently of their usage sites.

Add @mappings annotation

For generic comments about mappings. This section will be appended to
the generated documentation after `@mapping` annotations get rendered.

Highlight entire annotation line, when appropriate

Things look prettier when the annotation coloring extends over the
entire contents of the line.

Add LICENSE.txt

Match more things for links

Now we match `|g:FooBar|` and `|.vimrc|`, which we failed to do before.

Use \s consistently, to handle tabs as well as spaces

Make indented blocks work

We were misdetecting the end of the docblock because our `end` regex
could match lines like:

    <space><space>"

(ie. a 0 or 1-width space, followed by a non-quote)

Fix that by looking for non-space, non-tab, non-quote instead.

Also, use "\s" for whitespace, so that we deal with tabs properly as
well as spaces.

Drop @header support

We don't need it. Anything under @plugin is implicitly in the "header"
region unless explicitly marked otherwise (ie. with @footer or such).

Add source documentation

Written using docvim comments, of course. I'll add the generated outputs
later (can't do so yet as I am still boostrapping the docvim tool
itself).

Make docvim{Star,Bar} match their containing matches

Add missing docvimSubheadingPrefix link

Add highlighting of pre-fenced regions

Add support for 'settings' and <CTRL-keys>

Don't allow spaces inside backtick ranges

Initial commit

This is the work-in-progresss syntax highlighting for the
not-yet-released "docvim" syntax (this will be a tool that I'll release
for embedding extractable documentation inline inside Vim plugins).