From bbca3485eeb9415666c6d339b7cdfecb0fce4f5a Mon Sep 17 00:00:00 2001 From: Cosmo Myzrail Gorynych Date: Sun, 22 Dec 2024 03:13:27 +1200 Subject: [PATCH] :zap: Remove Safari considerations for now, add Linux troubleshooting page --- docs/.vuepress/locales/en.ts | 2 +- docs/.vuepress/theme.ts | 4 +-- docs/safari-gotchas.md | 44 ---------------------------- docs/troubleshoot-linux.md | 57 ++++++++++++++++++++++++++++++++++++ 4 files changed, 60 insertions(+), 47 deletions(-) delete mode 100644 docs/safari-gotchas.md create mode 100644 docs/troubleshoot-linux.md diff --git a/docs/.vuepress/locales/en.ts b/docs/.vuepress/locales/en.ts index 4f235f1..c8b83d4 100644 --- a/docs/.vuepress/locales/en.ts +++ b/docs/.vuepress/locales/en.ts @@ -35,5 +35,5 @@ export const enSidebar = sidebar([ 'cli-api', 'bun-api', 'client-api', - 'safari-gotchas' + 'troubleshoot-linux' ]); diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts index 5ce6690..40bc3b6 100644 --- a/docs/.vuepress/theme.ts +++ b/docs/.vuepress/theme.ts @@ -5,8 +5,8 @@ import { enNavbar, enSidebar } from './locales/en'; export default hopeTheme({ hostname: 'https://buntralino.github.io/', logo: '/Buntralino@smoll.png', - repo: 'https://github.com/buntralino/buntralino.github.io/', - docsRepo: 'https://github.com/buntralino/buntralino.github.io/', + repo: 'https://github.com/buntralino/buntralino.github.io', + docsRepo: 'https://github.com/buntralino/buntralino.github.io', docsBranch: 'main', docsDir: '/docs', titleIcon: false, diff --git a/docs/safari-gotchas.md b/docs/safari-gotchas.md deleted file mode 100644 index d5972d1..0000000 --- a/docs/safari-gotchas.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -icon: poop ---- - -# Safari considerations - -Buntralino uses an OS' built-in browser to stay relatively lightweight — which is good! But for Mac users, Safari browser is known to lag behind the modern standards, and its version range depends on the version of macOS itself — contrary to Windows where Edge gets continuously updated regularly. - -You define the minimum required OS version for your app to run on, but Buntralino itself supports macOS v11+. If we take the newest possible Safari version 16.6.1 on Big Sur ([see Wikipedia](https://en.wikipedia.org/wiki/Safari_(web_browser)#Version_compatibility)), and [look it up on caniuse.com](https://caniuse.com/?compare=safari+16.6&compareCats=all), we will see that this version is missing some features that may be crucial to your application: - -* DOM Auxclick event; -* DOM Touch events; -* AV1 video format; -* OGG/Theora video format; -* CSS counter styles; -* CSS `overflow: overlay`; -* CSS `text-justify` property; -* CSS `text-wrap: balance`; -* CSS `touch-action` property; -* CSS container style queries; -* CSS @scope rules; -* CSS3 `attr()` function support for all properties; -* HTML Media Capture; -* Web MIDI API; -* Object.observe data binding; -* Custom protocol handling; -* Web Bluetooth; -* Web Serial API; -* WebGPU; -* WebHID API; -* Web NFC; -* WebTransport; -* WebUSB; -* WebVR API; -* WebXR Device API. - -There are also some features that are not needed in a Buntralino project, but might be used by your dependencies: - -* Filesystem & FileWriter API; -* File System Access API. - -Not using any of these features? Good! Your application is able to run anywhere without issues. - -Older Safari versions also don't support many modern JS features, but, if you're using the default template, its ESBuild configuration already transforms all the code to support Safari v16.6.1. \ No newline at end of file diff --git a/docs/troubleshoot-linux.md b/docs/troubleshoot-linux.md new file mode 100644 index 0000000..9f875e0 --- /dev/null +++ b/docs/troubleshoot-linux.md @@ -0,0 +1,57 @@ +--- +shortTitle: Linux troubleshooting +icon: rectangle-xmark +--- + +# Troubleshooting apps not running Linux + +:::note +This page automatically opens when a Buntralino application fails to start a GUI process in time. Buntralino is a framework for building different cross-platform apps. + +If you're the developer of the app launched, you should include these instructions in your troubleshooting and installation guides. + +If you're a user of the app that opened this page, you can follow this guide to fix the problem on your machine but contact the developer of the app if the issue persists. Please don't bother Buntralino developers about apps not built by Buntralino developers (: +::: + +Buntralino uses Neutralino.js, and Neutralino.js requires `libwebkit2gtk` v4.0 or v4.1 installed in the system to create GUI windows. `libwebkit2gtk` is a library that provides a WebKit-based rendering engine for GTK applications, or, simply put, allows app developers to display webpage content in their apps. If nothing appears when you launch an app built on Buntralino, this is probably because `libwebkit2gtk` is missing in your system. + +Here's a documentation page on how to install `libwebkit2gtk` on various popular Linux distributions if it is missing: + +## Ubuntu and Debian + +For Ubuntu and Debian, you can install `libwebkit2gtk` using the following commands: + +```bash +sudo apt update +sudo apt install libwebkit2gtk-4.0-37 +``` + +## Fedora + +For Fedora users, you can install `libwebkit2gtk` with the following command: + +```bash +sudo dnf install webkit2gtk3 +``` + +## Arch Linux + +On Arch Linux, you can install `libwebkit2gtk` using the following command: + +```bash +sudo pacman -S webkit2gtk +``` + +## openSUSE + +For openSUSE, you can install `libwebkit2gtk` with the following command: + +```bash +sudo zypper install libwebkit2gtk-4_0-37 +``` + +--- + +:::note Are we missing something? +If a solution for the operating system you use is missing on this page or if the solution was incomplete/incorrect, you can contribute to this page with the "Edit this page" link below ⬇️ +::: \ No newline at end of file