mirror of
https://github.com/wailsapp/wails.git
synced 2025-05-07 03:32:15 +08:00
749c433ca6
* added nospinner flag to disable spinner in ci environment Signed-off-by: delta <delta@deltalab.dev> * deduplicated result message Signed-off-by: delta <delta@deltalab.dev> * removed flag and added terminal check Signed-off-by: delta <delta@deltalab.dev> * added changelog entry Signed-off-by: delta <delta@deltalab.dev> --------- Signed-off-by: delta <delta@deltalab.dev> |
||
|---|---|---|
| .. | ||
| docs | ||
| generate | ||
| overrides | ||
| shared | ||
| CNAME | ||
| 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.txtto install the required dependencies - Run
mkdocs serveto serve the documentation locally - Run
mkdocs buildto build the documentation
Contributing
If you would like to contribute to the documentation, please feel free to open a PR!