mirror of
https://github.com/wailsapp/wails.git
synced 2025-05-10 22:19:46 +08:00
![]() * Support for linux deb,rpm,arch linux packager packaging * remove optional tasks from linux:package task CHANGELOG.md * Update Taskfile.linux.yml * Integrated nfpm into CLI. Fixed task update. * package tool fixes and add bundle name field empty name guard * add linux depdencies * Add some docs * Fixed tests. Updated task to latest. * Update v3/internal/commands/tool_package.go Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Remove doctor references to nfpm --------- Co-authored-by: Lea Anthony <lea.anthony@gmail.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> |
||
---|---|---|
.. | ||
docs | ||
generate | ||
overrides | ||
shared | ||
CNAME | ||
Dockerfile | ||
mkdocs.insiders.yml | ||
mkdocs.yml | ||
README.md | ||
requirements.insiders.txt | ||
requirements.txt | ||
Taskfile.yml |
v3 Docs
This is the documentation for Wails v3. It is currently a work in progress.
If you do not wish to build it locally, it is available online at https://wailsapp.github.io/wails/.
Recommended Setup Steps
Install the wails3 CLI if you haven't already:
go install github.com/wailsapp/wails/v3/cmd/wails3@latest
The documentation uses mkdocs, so you will need to install Python. Once installed, you can setup the documentation by running the following command:
wails3 task docs:setup
This will install the required dependencies for you.
If you have installed the wails3 CLI, you can run the following command to build the documentation and serve it locally:
wails3 task docs:serve
Manual Setup
To install manually, you will need to do the following:
- Install Python
- Run
pip install -r requirements.txt
to install the required dependencies - Run
mkdocs serve
to serve the documentation locally - Run
mkdocs build
to build the documentation
Contributing
If you would like to contribute to the documentation, please feel free to open a PR!