From 5833f0f109ee8bdee2507f16fc230de3f03fd3f0 Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Tue, 5 Sep 2023 18:26:10 +1000 Subject: [PATCH] More docs. --- mkdocs-website/Taskfile.yml | 24 +++++++++++++++++++ mkdocs-website/docs/development/status.md | 21 ++++++++--------- mkdocs-website/docs/stylesheets/extra.css | 8 +++++-- mkdocs-website/mkdocs.yml | 8 +++++++ mkdocs-website/requirements.insiders.txt | Bin 0 -> 1680 bytes mkdocs-website/requirements.txt | Bin 617 -> 1482 bytes v3/pkg/application/options_win.go | 27 ++++++++++++++++++---- 7 files changed, 71 insertions(+), 17 deletions(-) create mode 100644 mkdocs-website/requirements.insiders.txt diff --git a/mkdocs-website/Taskfile.yml b/mkdocs-website/Taskfile.yml index a94af273..3d8aa8b1 100644 --- a/mkdocs-website/Taskfile.yml +++ b/mkdocs-website/Taskfile.yml @@ -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 diff --git a/mkdocs-website/docs/development/status.md b/mkdocs-website/docs/development/status.md index 4d8347b5..18f38cdf 100644 --- a/mkdocs-website/docs/development/status.md +++ b/mkdocs-website/docs/development/status.md @@ -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 diff --git a/mkdocs-website/docs/stylesheets/extra.css b/mkdocs-website/docs/stylesheets/extra.css index 296850e2..0426eb97 100644 --- a/mkdocs-website/docs/stylesheets/extra.css +++ b/mkdocs-website/docs/stylesheets/extra.css @@ -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; -} \ No newline at end of file +} + +.md-typeset { + font-weight: 100; +} diff --git a/mkdocs-website/mkdocs.yml b/mkdocs-website/mkdocs.yml index f991499d..0dfebe14 100644 --- a/mkdocs-website/mkdocs.yml +++ b/mkdocs-website/mkdocs.yml @@ -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 diff --git a/mkdocs-website/requirements.insiders.txt b/mkdocs-website/requirements.insiders.txt new file mode 100644 index 0000000000000000000000000000000000000000..8a109b995789dd264cf553b63cd428408c107b85 GIT binary patch literal 1680 zcmezW&xs+CA&DWCA&0@1!Ir^@L65-@O7b#rfn^dIN*PKRG8xhsN*Qt(iW%}5N*M|m zOu*_*;OdPSK?sfK5pRn*-8q zz@Wzfa-kVicQFG9g8Z7wkjzj5HpLL^Dm?~>4e1OS3jNmdLU64@AVW?opg~k-fR!asw24k>kzTnWzW=LVkXDCOq5u^%Y zGAL||7!WET=7anNQUh~4%p6b*2Qwrxq%ov|-2qYuatFk=TyXrPGo&)4Fr+f1G8BN- zK;%Io4vLRls9nhn#c)|ua9E?u>N2E*Lrj+;nIWGcmmwF-D*@Y4%%ICqz>vdG3RaWH zpbHHbkX;}Q2^VC$biuI?(VYoSPYMhU3<_ZVB@EgO84M*1B@6`&#SB&q`V9I|@eGDi zh9m|(s0;KNiWv$SN*O?L1WNUJ4A~6&4ESvUrI|d2Vz3@i9w=tegPQHYkj#(<4#`w7 zX~|&7V9sF9kjwx|3lYw45kdm3>FNQ45?r;g~5m+37jHK z8Il-`7!1KNPRKQ>3>6HZP=L4zlnN2?017#XDFqCP450j!2zF~8LpnIFAo&%c0u(=> zviT7Kw=0Khlva&3~AszmCKOAkO|KHAhnR3 z0m?y;+y%-x=?tJWmd8*6O+AqGX9mvkp!8F~P{{x?1(Moz8F2d+WG+NEOdlv_K`~Sb z^(!dvgD^}U3@PA}6XbJ{EGS$+Dj=Z(QUS_w6<~WH zr7FZ2@n11Y*n#9>egvgah$*1>F=T+a8RYw7aPCWl=4Vh0gUp854=eXU vx>Fg-kje!}`2o^j%233R11`an7>uFr1lbBJ6UxEinaq#@E~g-A4b_(b5PAA= literal 0 HcmV?d00001 diff --git a/mkdocs-website/requirements.txt b/mkdocs-website/requirements.txt index bfed5e978310b35d3237f963f9e230309d69717f..05dbce5b9d3aa8dfbac6688ebb503ae13d6ec36d 100644 GIT binary patch literal 1482 zcmezW&xs+CA&DWCA&0@1!Ir^@L65-@O7b#rfn^dIN*PKRG8xhsN*Qt(iW%}5N*M|m zOu*_*;OdPSK?sfK5pRn*-8q zz@Wzfa-kVicQFG9g8Z7wkjzj5HpLL^Dm?~>4e1OS3jNmdLU64@AVW?opg~k-fR!asw24k>kzTnWzW=LVkXDCOq5u^%Y zGAL||7!WET=7anNQUh~4%p6b*2Qwrxq%ov|-2qYuatFk=TyXrPGo&)4Fr+f1G8BN- zK;%Io4vLRls9nhn#c)|ua9E?u>N2E*Lrj+;nIWGcmmwF-D*@Y4%%ICqz>vdG3RaWH zpbHHbkX;}Q2^VC$biuI?(VYoSPqqx8a02aujOFCi%%p#tPHP%MMYgQZANC_qvq$P7>#DP|~O0HsKn3PT2v zJrKWve4ofr!jJ||jkydd44L4315yh~Q=qg5Ntd8Bm(Bo+ojisTXt;y?ZOC8-&MTmh zFJP!-0GR?wC-{5|G8dv7rmv8p6dWs+P``q54G6>JL4EHY=z~f Sa&UMiGh~2sI3%s1`Vs)4LfCl# literal 617 zcmZ=tOiInMwKdW+G}1HVN=i*EEy+wP%_+_=EikdQH3115aV4h~m1L%6+S(c!7#ZuC z>lqnwC1)fS6{nWy=H(aVCgx;Tr54%R8tWP98E_@%WF}|Z+FIxt>X~yT=jY@XCFUmD z+8XGY=$UaP7Z(?&=A3N)7J#fa25HJp$xki@@l5rMxN^Zf-Q2{I)S}G999vsUJtI9cbYb1pijvg4 z;>`R!utq~YL#~3v~EoWD7kDuA