mirror of
https://github.com/wailsapp/wails.git
synced 2026-03-14 14:45:49 +01:00
More docs.
This commit is contained in:
parent
eb2ad258ed
commit
5833f0f109
7 changed files with 71 additions and 17 deletions
|
|
@ -12,6 +12,22 @@ tasks:
|
|||
cmds:
|
||||
- python -m pip install -r requirements.txt --user
|
||||
|
||||
setup:insiders:
|
||||
summary: Setup the project (insiders)
|
||||
preconditions:
|
||||
- sh: python{{exeExt}} --version
|
||||
msg: "Looks like Python isn't installed. Python is required to build the documentation: https://www.python.org/downloads/"
|
||||
cmds:
|
||||
- python -m pip install -r requirements.insiders.txt --user
|
||||
|
||||
upgrade:insiders:
|
||||
summary: Upgrade the project (insiders)
|
||||
preconditions:
|
||||
- sh: python{{exeExt}} --version
|
||||
msg: "Looks like Python isn't installed. Python is required to build the documentation: https://www.python.org/downloads/"
|
||||
cmds:
|
||||
- python -m pip install -r requirements.insiders.txt --upgrade --user
|
||||
|
||||
build:
|
||||
summary: Builds the documentation
|
||||
preconditions:
|
||||
|
|
@ -27,3 +43,11 @@ tasks:
|
|||
msg: "Looks like mkdocs isn't installed. Run `wails3 task setup` or `task setup` in the documentation directory to install it."
|
||||
cmds:
|
||||
- mkdocs serve
|
||||
|
||||
serve:insiders:
|
||||
summary: Builds the documentation and serves it locally
|
||||
preconditions:
|
||||
- sh: mkdocs --version
|
||||
msg: "Looks like mkdocs isn't installed. Run `wails3 task setup` or `task setup` in the documentation directory to install it."
|
||||
cmds:
|
||||
- mkdocs serve --config-file mkdocs.insiders.yml
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Status
|
||||
|
||||
Status of features in v3.
|
||||
Status of features in v3.
|
||||
|
||||
!!! note
|
||||
|
||||
|
|
@ -11,7 +11,6 @@ Status of features in v3.
|
|||
|
||||
- Linux is not yet up to feature parity with Windows/Mac
|
||||
|
||||
|
||||
## Application
|
||||
|
||||
Application interface methods
|
||||
|
|
@ -349,19 +348,19 @@ TODO:
|
|||
|
||||
## Windows Specific
|
||||
|
||||
- [ ] Translucency
|
||||
- [x] Translucency
|
||||
- [x] Custom Themes
|
||||
|
||||
### Windows Options
|
||||
|
||||
| Feature | Default | Notes |
|
||||
|-----------------------------------|---------|---------------------------------------------|
|
||||
| BackdropType | | |
|
||||
| DisableIcon | | |
|
||||
| Theme | | |
|
||||
| CustomTheme | | |
|
||||
| DisableFramelessWindowDecorations | | |
|
||||
| WindowMask | nil | Makes the window the contents of the bitmap |
|
||||
| Feature | Default | Notes |
|
||||
|-----------------------------------|---------------|---------------------------------------------|
|
||||
| BackdropType | Solid | |
|
||||
| DisableIcon | false | |
|
||||
| Theme | SystemDefault | |
|
||||
| CustomTheme | nil | |
|
||||
| DisableFramelessWindowDecorations | false | |
|
||||
| WindowMask | nil | Makes the window the contents of the bitmap |
|
||||
|
||||
## Linux Specific
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
--md-primary-fg-color: #2a2a2a;
|
||||
--md-default-bg-color: #191919;
|
||||
--md-footer-bg-color--dark: #2a2a2a;
|
||||
--md-default-fg-color: #cccccc;
|
||||
--md-default-fg-color: #e0e0e0;
|
||||
}
|
||||
|
||||
.md-header__button.md-logo img, .md-header__button.md-logo svg {
|
||||
|
|
@ -15,4 +15,8 @@
|
|||
display: block;
|
||||
height: 2rem;
|
||||
width: auto;
|
||||
}
|
||||
}
|
||||
|
||||
.md-typeset {
|
||||
font-weight: 100;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,9 +1,13 @@
|
|||
site_name: "alpha"
|
||||
site_description: The Wails Project - Build beautiful cross-platform applications using Go
|
||||
repo_url: https://github.com/wailsapp/wails
|
||||
edit_uri: edit/v3-alpha/mkdocs-website/docs/
|
||||
theme:
|
||||
name: material
|
||||
custom_dir: overrides
|
||||
logo: assets/images/wails-logo-horizontal-dark.svg
|
||||
icon:
|
||||
repo: fontawesome/brands/github
|
||||
favicon: assets/images/favicon.svg
|
||||
features:
|
||||
- navigation.tabs
|
||||
|
|
@ -18,11 +22,13 @@ theme:
|
|||
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- search.share
|
||||
|
||||
- content.tabs.link
|
||||
- content.tabs.annotation
|
||||
- content.tabs.copy
|
||||
- content.code.copy
|
||||
- content.action.edit
|
||||
language: en
|
||||
palette:
|
||||
# Palette toggle for light mode
|
||||
|
|
@ -86,6 +92,8 @@ markdown_extensions:
|
|||
alternate_style: true
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- pymdownx.details
|
||||
|
|
|
|||
BIN
mkdocs-website/requirements.insiders.txt
Normal file
BIN
mkdocs-website/requirements.insiders.txt
Normal file
Binary file not shown.
Binary file not shown.
|
|
@ -32,39 +32,58 @@ const (
|
|||
|
||||
type WindowsWindow struct {
|
||||
// Select the type of translucent backdrop. Requires Windows 11 22621 or later.
|
||||
// Only used when window's `BackgroundType` is set to `BackgroundTypeTranslucent`.
|
||||
// Default: Auto
|
||||
BackdropType BackdropType
|
||||
|
||||
// Disable the icon in the titlebar
|
||||
// Default: false
|
||||
DisableIcon bool
|
||||
// Theme. Defaults to SystemDefault which will use whatever the system theme is. The application will follow system theme changes.
|
||||
|
||||
// Theme (Dark / Light / SystemDefault)
|
||||
// Default: SystemDefault - The application will follow system theme changes.
|
||||
Theme Theme
|
||||
// Custom colours for dark/light mode
|
||||
|
||||
// Specify custom colours to use for dark/light mode
|
||||
// Default: nil
|
||||
CustomTheme *ThemeSettings
|
||||
|
||||
// Disable all window decorations in Frameless mode, which means no "Aero Shadow" and no "Rounded Corner" will be shown.
|
||||
// "Rounded Corners" are only available on Windows 11.
|
||||
// Default: false
|
||||
DisableFramelessWindowDecorations bool
|
||||
|
||||
// WindowMask is used to set the window shape. Use a PNG with an alpha channel to create a custom shape.
|
||||
WindowMask []byte
|
||||
// Default: nil
|
||||
WindowMask []byte
|
||||
|
||||
// WindowMaskDraggable is used to make the window draggable by clicking on the window mask.
|
||||
// Default: false
|
||||
WindowMaskDraggable bool
|
||||
|
||||
// WebviewGpuIsDisabled is used to enable / disable GPU acceleration for the webview
|
||||
// Default: false
|
||||
WebviewGpuIsDisabled bool
|
||||
|
||||
// ResizeDebounceMS is the amount of time to debounce redraws of webview2
|
||||
// when resizing the window
|
||||
// Default: 0
|
||||
ResizeDebounceMS uint16
|
||||
|
||||
// Disable the menu bar for this window
|
||||
// Default: false
|
||||
DisableMenu bool
|
||||
|
||||
// Event mapping for the window
|
||||
// Event mapping for the window. This allows you to define a translation from one event to another.
|
||||
// Default: nil
|
||||
EventMapping map[events.WindowEventType]events.WindowEventType
|
||||
|
||||
// HiddenOnTaskbar hides the window from the taskbar
|
||||
// Default: false
|
||||
HiddenOnTaskbar bool
|
||||
|
||||
// EnableSwipeGestures enables swipe gestures for the window
|
||||
// Default: false
|
||||
EnableSwipeGestures bool
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue