{"id":13592644,"url":"https://github.com/luakit/luakit","last_synced_at":"2025-05-14T02:07:04.557Z","repository":{"id":37405934,"uuid":"824451","full_name":"luakit/luakit","owner":"luakit","description":"Fast, small, webkit based browser framework extensible by Lua.","archived":false,"fork":false,"pushed_at":"2025-02-14T12:28:55.000Z","size":7077,"stargazers_count":2149,"open_issues_count":219,"forks_count":248,"subscribers_count":82,"default_branch":"develop","last_synced_at":"2025-04-11T01:41:45.190Z","etag":null,"topics":["c","lua","luajit","luakit","vim-like","web-browser"],"latest_commit_sha":null,"homepage":"https://luakit.github.io/","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luakit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING.GPLv3","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2010-08-08T10:09:04.000Z","updated_at":"2025-04-10T14:56:13.000Z","dependencies_parsed_at":"2024-01-15T03:58:44.607Z","dependency_job_id":"f91277de-aadb-439b-905d-1b96b68651cc","html_url":"https://github.com/luakit/luakit","commit_stats":null,"previous_names":["mason-larobina/luakit"],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luakit%2Fluakit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luakit%2Fluakit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luakit%2Fluakit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luakit%2Fluakit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luakit","download_url":"https://codeload.github.com/luakit/luakit/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254052747,"owners_count":22006716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","lua","luajit","luakit","vim-like","web-browser"],"created_at":"2024-08-01T16:01:11.615Z","updated_at":"2025-05-14T02:06:59.539Z","avatar_url":"https://github.com/luakit.png","language":"Lua","readme":"# Luakit\n\nluakit is a fast, light and simple to use micro-browser framework\nextensible by Lua using the WebKit web content engine and the GTK+\ntoolkit.\n\n\n### Don't Panic!\n\nYou don't have to be a developer to use luakit on a daily basis. If you\nare familiar with quitebrowser, vim-browser, jumanji or extensions like\nVimium or cVim etc, you will find luakit behaves similarly out of the box.\n\n\n## Requirements\n\n * GTK+ 3\n * Lua 5.1 or LuaJIT 2\n * lfs (lua file system)\n * webkit2gtk\n * sqlite3\n * gstreamer (for video playback)\n * lua-socket (for gopher support)\n\n\n## Installing\n\nLuakit is available on most Linux Distributions and BSD system via their\npackage managers. A few examples below:\n\n * Debian/Ubuntu: apt-get install luakit\n * Gentoo: emerge luakit\n * Guix: guix install luakit\n * Arch: pacman -S luakit\n * FreeBSD: pkg install luakit\n * OpenBSD: pkg\\_add luakit\n * Void Linux: xbps-install luakit\n\nPackaging status:\n\n[![Packaging Status](https://repology.org/badge/vertical-allrepos/luakit.svg?header=)](https://repology.org/project/luakit/versions)\n\n\n## Installing from source\n\nMake sure you system fulfills the requirements listed above, then\ninstall luakit with the following commands:\n\n    $ git clone https://github.com/luakit/luakit.git\n    $ cd luakit\n    $ make\n    $ sudo make install\n\nUninstall with:\n\n    $ sudo make uninstall\n\nNote: If you are on BSD, you might need to use `gmake`.\n\n\n## Use Luakit\n\nJust run:\n\n    $ luakit [URI..]\n\nOr to see the full list of luakit launch options run:\n\n    $ luakit -h\n\nLuakit works with vim-style bindings. To find out more, type `:help`\nwithin luakit.\n\n\n## Configuration\n\nLuakit configuration files are written in `lua`. This means you can\nprogram within the config files, which make the configuration options\nendless.\n\nThere are three ways to customize luakit.\n\n**1. within luakit**\n\nAfter starting luakit, type `:settings`. This page shows you webkit\nengine related settings.\n\n**2. userconf.lua**\n\nCreate a file called `$HOME/.config/luakit/userconf.lua`. Then add\nyour configuration there. Configuration in this file supersedes\nconfiguration set in `:settings`\n\n**3. copy rc.lua**\n\nThe most powerful customization is to copy `rc.lua` from\n`/etc/xdg/luakit/rc.lua` to `$HOME/.config/luakit/rc.lua`\n\nWhen this file is found, `/etc/xdg/luakit/rc.lua` is ignored.\n\nBe informed that when luakit is updated, you may need to adapt changes\nfrom `/etc/xdg/luakit/rc.lua` to your own copy.\n\n\n## Colors and fonts\n\nCopy the `/etc/xdg/luakit/theme.lua` to\n`$HOME/.config/luakit/theme.lua`. You can change fonts and colors there.\n\n\n## Development Information\n\nThis section contains information about the compile and testing process.\n\nLuakit honors the PREFIX variable. The default is `/usr/local`.\n\n    $ make PREFIX=/usr\n    $ sudo make PREFIX=/usr install\n\nNotes:\n  - You also have to set the PREFIX when uninstalling.\n  - If you want to change PREFIX after a previous build, you need to `make clean` first.\n\nLuakit uses `luajit` by default, to use `lua` you can turn off luajit\nwith:\n\n    $ make USE_LUAJIT=0\n\nTo build with local paths (interesting for package maintainer and\ncontributers). You may wish to build luakit with:\n\n    $ make DEVELOPMENT_PATHS=1\n\nThis lets you start luakit from the build directory, using the config\nand libraries within the same.\n\nTake a look at `config.mk` for more options.\n\nIf you made changes and want to know if luakit is still working properly,\nyou can execute the test suite with:\n\n    $ make test\n\n\n## Debugging Luakit\n\n**Enable debug output**\n\nDebug output can be turned on by starting luakit with the `--log` option.\n\n    $ luakit --log=verbose              # or: -v\n    $ luakit --log=all=debug            # or: --log=debug\n    $ luakit --log=lua/adblock=debug    # turn on debug on for the adblock module.\n\nConsole output an also be seen within luakit using `:log` when the\n[log_chrome](https://luakit.github.io/docs/modules/log_chrome.html)\nmodule is loaded (default). Note that debug log level may lead to a race\ncondition when the update of the log page leads to debug output, which\ncauses an update of the :log page.\n\n**Execute lua within Luakit**\n\nIf you want to examine the lua state at runtime, you can do so by\nrunning lua script within luakit. This will print \"Hello World!\"\non the console.\n\n    :lua print(\"Hello World!\");\n\nw:notify() can be used to show the output in the input/status bar. This\nexample shows the configuration directory in the input/status bar.\n\n    :lua w:notify(luakit.config_dir)\n\nPrint the lua package search paths:\n\n    :lua w:notify(package.path:gsub(\";\",\"\\n\"))\n\nTo extend the lua debugging capabilities, you can copy \"inspect.lua\"\nfrom [here](https://github.com/kikito/inspect.lua) into the luakit\nconfiguration directory. Now you can inspect complex data types like\ntables:\n\n    :lua local inspect = require \"inspect\"; w:notify(inspect(webview))\n\n\n## Tips and Fixes:\n\n**Video playback**\n\nIf you're having issues with video playback, this is often related to\nbuggy graphic drivers. It often helps to set LIBGL\\_DRI3\\_DISABLE before\nstarting luakit:\n\n    $ export LIBGL_DRI3_DISABLE=1\n\n**HiDPI Monitor Configuration**\n\nIf you have a HiDPI monitor (\u003e 1920x1080) and find that web pages are\ntoo small, you can change the `webview.zoom_level` on the settings page\n(luakit://settings/) to 150 or 200 as per your taste.\n\n\n## Reporting Bugs\n\nPlease note that most rendering related issues come from the used webkit\nengine and can not be fixed by luakit. If you think your issue is luakit\nrelated, please use the bug tracker at:\n\n  https://github.com/luakit/luakit/issues\n\nComing from a very old luakit version? Look at the\n[MIGRATION](MIGRATE.md) document.\n\n\n## IRC\n\nJoin us in `#luakit` on the `irc.oftc.net` network.\n\n","funding_links":[],"categories":["Lua","LUA","后端开发框架及项目"],"sub_categories":["后端项目_其他"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluakit%2Fluakit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluakit%2Fluakit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluakit%2Fluakit/lists"}