Extra scripts that implement experimental features, highlight custom files/languages
Switch branches/tags
Nothing to show
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
filetype filetype git: Avoid highlighter conflicts Sep 11, 2018
games Adapt to upstream changes Jul 18, 2018
widgets widgets git-branch: POSIX changes, document `modeline_git_branch` Sep 1, 2018
README.md README: Update and compliment Oct 27, 2018
UNLICENSE Document the license of the repository Sep 15, 2016
autodownload.asciidoc Set the scripts names as title for the documentation Sep 4, 2018
autodownload.kak autodownload: Make code more portable Aug 25, 2018
autosplit.asciidoc Set the scripts names as title for the documentation Sep 4, 2018
autosplit.kak Adapt to upstream changes Jul 18, 2018
cdmenu.asciidoc cdmenu: Fix errors in the documentation Sep 7, 2018
cdmenu.kak cdmenu: Menu to jump to a given path quickly Sep 7, 2018
comnotes.kak Adapt to upstream changes Jul 18, 2018
dictcomplete.asciidoc Set the scripts names as title for the documentation Sep 4, 2018
dictcomplete.kak dictcomplete: Adapt to upstream changes, re-factor Aug 25, 2018
dvtm.kak Adapt to upstream changes Jul 18, 2018
fzf.asciidoc Fix the `fzf` script documentation Feb 8, 2017
fzf.kak Adapt to upstream changes Jul 18, 2018
fzy.asciidoc Add support for `fzy` Feb 8, 2017
fzy.kak Adapt to upstream changes Jul 18, 2018
grepmenu.asciidoc Add a pattern search utility `grepmenu` Feb 3, 2018
grepmenu.kak grepmenu: Factorize and document Oct 23, 2018
hatch_terminal.asciidoc Set the scripts names as title for the documentation Sep 4, 2018
hatch_terminal.kak Adapt to upstream changes Jul 18, 2018
idsession.asciidoc idsession: Fix a spelling mistake Nov 17, 2018
idsession.kak idsession: Refactorize, seed the session name with the server PID Nov 17, 2018
lineindent.asciidoc Improve the `lineindent` function, document it Oct 22, 2016
lineindent.kak Adapt to upstream changes Jul 18, 2018
overstrike.asciidoc Set the scripts names as title for the documentation Sep 4, 2018
overstrike.kak Adapt to upstream changes Jul 18, 2018
readline.kak Document all the options with docstrings Jun 8, 2017
searchmarks.asciidoc searchmarks: Search with candidate counts as markers Sep 4, 2018
searchmarks.kak searchmarks: Search with candidate counts as markers Sep 4, 2018
syntastic.asciidoc Allow custom filetypes to benefit from auto linting Oct 21, 2016
syntastic.kak Adapt to upstream changes Jul 18, 2018
tldr.asciidoc Set the scripts names as title for the documentation Sep 4, 2018
tldr.kak tldr: Adapt to upstream changes Oct 6, 2018
utils.kak Adapt to upstream changes Jul 18, 2018
vcs.asciidoc vcs: Compliment the documented example Oct 6, 2018
vcs.kak vcs: Fix code, improve the documentation Aug 20, 2018
versioncheck.asciidoc versioncheck: Version check at startup Sep 28, 2018
versioncheck.kak versioncheck: Version check at startup Sep 28, 2018

README.md

kakoune-extra

This repository contains several scripts for the kakoune code editor that were not eligible to be merged with the core scripts that kakoune ships with, but still implement useful experimental features or allow highlighting of custom file formats.

Scripts are all fairly well commented, but those whose use require more than a quick sentence in an inlined comment have their own .asciidoc documentation file (e.g. fzf.asciidoc).

Versioning

The master branch is compatible with the latest stable version of the editor, while the dev branch targets the latest HEAD, for users who use the Git version.

How to use the scripts

System wide availability

Drop the scripts relevant to your interest in the /usr/share/kak/rc directory. They will be automatically loaded everytime a new kak process is started.

Per user availability

Copy the scripts you want to have autoloaded in the $XDG_CONFIG_HOME/kak/rc directory. They will be automatically loaded everytime a new kak process is started.

Keeping scripts up to date

If you want to be able to update the scripts easily, clone this repository and create symbolic links to the scripts you want to have loaded automatically in the system/user rc directory (c.f. previous points).

Categories

The scripts that are in the root directory of the repository are general purpose, while the following categories hold scripts with particular uses.

Filetypes

Support for filetypes that are not handled by the upstream version.

Games

Small games to pass time, with minimal dependencies.

Widgets

Placed in the widgets directory, those scripts store information in variables whose prefix is modeline_. As their name suggest, they are aimed at being used in the modelinefmt variable, and hold specific information.

Example: the percent widget will update the modeline_pos_percent option with the relative position of the cursor in the buffer (using a percentage). You can use it by either inserting %opt{modeline_pos_percent}% variable in modelinefmt, or directly in a script or yours.

Contributing

Feel free to create a pull request if you want to share a useful script.

License

All the scripts in this repository are UNLICENSE'd.