https://github.com/s3rvac/vim-syntax-redminewiki

Redmine wiki syntax highlighting for Vim
https://github.com/s3rvac/vim-syntax-redminewiki

redmine syntax-highlighting vim

Last synced: 3 days ago
JSON representation

Redmine wiki syntax highlighting for Vim

• Host: GitHub
• URL: https://github.com/s3rvac/vim-syntax-redminewiki
• Owner: s3rvac
• Created: 2013-10-16T15:24:27.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-11-05T17:46:56.000Z (about 1 year ago)
• Last Synced: 2023-11-05T18:34:16.342Z (about 1 year ago)
• Topics: redmine, syntax-highlighting, vim
• Language: Vim Script
• Homepage:
• Size: 10.7 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Redmine Wiki Syntax For Vim

===========================

A Vim syntax-highlighting file for the [Redmine](https://redmine.org/) wiki.

Installation

============

If you use [pathogen](https://github.com/tpope/vim-pathogen), simply go into

the `bundle` directory and clone the repository in there:

```

cd ~/.vim/bundle

git clone https://github.com/s3rvac/vim-syntax-redminewiki.git

```

You can also install the plugin manually by copying the

[`syntax/redminewiki.vim`](https://raw.githubusercontent.com/s3rvac/vim-syntax-redminewiki/master/syntax/redminewiki.vim)

file to your `~/.vim/syntax` directory. If that directory does not exist,

create it.

Usage

=====

When you edit a Redmine wiki page in Vim, execute `:set ft=redminewiki` to

select the Redmine wiki highlighting (make sure that you have enabled syntax

highlighting). Alternatively, you can put the following autocommand to your

`.vimrc`:

```

" Consider all .redmine files as Redmine wiki files.

au BufNewFile,BufRead *.redmine set filetype=redminewiki

```

where `redmine` is the suffix of your Redmine wiki files.

If you use the [It's All Text](https://github.com/docwhat/itsalltext) Firefox

plugin to edit textareas in Vim, you can add something along these lines to

your `.vimrc`:

```

let s:opened_file_path = expand('%:p')

if s:opened_file_path =~ '\.mozilla/firefox/.*redmine'

    au BufRead,BufNewFile *.txt set filetype=redminewiki

endif

```

Then, when you launch Vim to edit a Redmine page (e.g. wiki or issue), a proper

file type will be selected automatically. Of course, this can be set up also

for other browser plugins, such as

[Vimperator](http://www.vimperator.org/vimperator). You just need to adjust the

regular expression matching `s:opened_file_path`.

Credits

=======

This syntax file is heavily based on the

[textile.vim](http://rubychan.de/share/textile.vim) syntax file by Kornelius

Kalnbach , 2006.