Installation

With the Unix philosophy in mind, Luakit is entirely customizable through its configuration files.
Those files are written in the Lua scripting language, thus allowing virtually unlimited features.
First, copy the configuration files to your $XDG_CONFIG_HOME folder:

cp -r $XDG_CONFIG_DIRS/luakit $XDG_CONFIG_HOME

Now you can edit any of these files to make your browser fits your needs. Even if you do not know much about Lua, the configuration is simple and well commented enough to make it straightforward.

Basic usage

Note: Most of the shortcuts are viewable and customizable from binds.lua.

Input fields

Many webpages have editable elements like dropdown lists, checkboxes, text fields and so on. While they work perfectly with the mouse, you may encounter some troubles using the follow commands.
In such a case, pressing the arrow keys may help.
Alternatively, you can use the focus inputTemplate:Keypress shortcut.

Bookmarks

If enabled (default configuration), bookmarks can be used from within Luakit.

Finally, fetch an adblock-compatible list, like Easylist, and save it to $XDG_DATA_HOME/luakit (mostly your ~/.local/share/luakit folder).

Don't forget to restart Luakit in order to apply the changes.

Bookmarks management

Sync

Bookmarks are stored in a simple plain text file: $XDG_DATA_HOME/luakit/bookmarks.
Each line is a bookmark. It is composed of 2 fields:

$XDG_DATA_HOME/luakit/bookmarks

link group

Warning: Each field is followed by a tabulation. If you insert spaces instead, the link will not be properly bookmarked.

Groups and links are alphabetically sorted, so there is no need to do it manually.

You can put a symbolic link in place of the default file to store your bookmarks anywhere on your machine.
This way if your are using a cloud sync application like Dropbox, you can keep your bookmarks synchronized between your different computers.

Import from Firefox

To import your bookmarks from Firefox, first you must export them to an HTML file using its bookmarks manager.
Now we must convert the XML file to a Luakit format.
You can use the following one-line awk command: