102 Commits

Author SHA1 Message Date
tauri
856fa302d0 Update Docs (#3409)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2025-07-22 12:14:51 +02:00
tauri
6d4c49663b Update Docs (#3115)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2025-01-10 22:29:08 +01:00
tauri
5c07d25475 Update Docs (#2944)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2024-11-05 18:17:03 +01:00
tauri
0e60fbc078 Update Docs (#2366)
Co-authored-by: FabianLars <FabianLars@users.noreply.github.com>
2024-07-04 18:00:31 +02:00
Colin McDonnell
6e028aa7d9 docs: add instructions for bun (#1441)
* docs: add instructions for bun

* fix spacing

* capitalization

* Updates

---------

Co-authored-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
2024-02-29 09:52:40 +01:00
tauri
a4e5a65009 chore(docs): Update Rust & TS docs (#1865)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2024-02-21 14:35:45 +01:00
tauri
6b5671734c chore(docs): Update Rust & TS docs (#1759)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2023-12-19 17:20:10 +01:00
tauri
98cc6f4680 chore(docs): Update Rust & TS docs (#1720)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2023-12-01 14:49:57 +01:00
Dueen Eduarda
9c8340cf94 docs: dialog persisted scope link (#1705) 2023-11-27 10:42:43 +01:00
Chase Knowlden
9e557fdb30 Fix an unmaintained link (#1702)
* Fix an unmaintained link

* change the other link too

---------

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
2023-11-26 20:38:18 +01:00
tauri
45203a9e82 chore(docs): Update Rust & TS docs (#1581)
Co-authored-by: FabianLars <FabianLars@users.noreply.github.com>
2023-09-30 12:08:19 +02:00
Lucas Fernandes Nogueira
7c4955334f feat(config): parse reference-style markdown links in descriptions (#1311) 2023-06-28 19:54:04 +02:00
Lucas Fernandes Nogueira
91d090b9ec fix(config): set max header level to 6 (#1310) 2023-06-28 19:53:14 +02:00
Lucas Fernandes Nogueira
80586cabe0 refactor(config): hierarchy based on config schema (#1306) 2023-06-22 08:23:11 +02:00
Lucas Fernandes Nogueira
929d60f9c9 feat(config): document enum variant properties, closes #1300 (#1301)
* feat(config): document for enum variant properties, closes #1300

* missing type def on tables when the type is an object

* if the value is required, do not use `null` in the Default column

* change [string] to string[]
2023-06-21 21:26:40 +02:00
tauri
2f54e68b8d Update Docs (#1295)
* chore(docs): Update Rust & TS docs

* Update docs/api/js/os.md

---------

Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
2023-06-14 19:30:10 +02:00
tauri
9cb807e0db chore(docs): Update Rust & TS docs (#1237)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2023-05-08 13:35:42 +02:00
tauri
984c03f2d3 chore(docs): Update Rust & TS docs (#1230)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2023-05-03 18:40:42 +02:00
FabianLars
21ed06933e cherry-pick(next): Fix typos and make other small changes 2023-03-25 20:48:54 +01:00
sameoldlab
0aa95c9ab1 fix scope example in shell api docs (#1143)
Changed `scope` example to provide an array, as described in the docs and how it works.
2023-03-06 10:17:54 +01:00
Fabian-Lars
efc811af94 fix: self-close br element in config.md 2023-02-08 11:59:39 +01:00
matthme
580a9070fe Improve allowlist docs (#1057)
* extended explanation of allowlist

* added note
2023-02-08 11:46:07 +01:00
Fabian-Lars
29bcd25876 docs(api.js): fix heading level in window api docs 2023-01-27 12:19:22 +01:00
tauri
d9a75c6896 chore(docs): Update Rust & TS docs (#1009)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-12-08 16:45:17 +01:00
tauri
64d4904070 chore(docs): Update Rust & TS docs (#1004)
Co-authored-by: FabianLars <FabianLars@users.noreply.github.com>
2022-12-03 20:15:00 +01:00
tauri
c92ef97be2 chore(docs): Update Rust & TS docs (#992)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-11-24 18:02:16 +01:00
Vilian Gerdzhikov
a2a9146cd7 corrections-v1 (#976)
* corrections-v1

* Update docs/guides/building/app-size.md

Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>

* Update docs/guides/features/system-tray.md

reverted preposition

Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>

* revert

Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>
2022-11-11 19:01:55 +01:00
tauri
219f3bd245 Update Docs (#971)
* chore(docs): Update Rust & TS docs

* Apply suggestions from code review

Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
2022-11-08 16:05:44 +01:00
Daniele Basso
9eb097175b Add more headers to gain more readability (#942)
* Enlighting generate-config-docs.js
- Adding note box to be more readable
- Removing unused variables/lines
- Smarter headers

* Cleaning from :::note
2022-10-17 19:59:12 +02:00
tauri
f8a59ae423 chore(docs): Update Rust & TS docs (#903)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-09-16 20:33:54 +02:00
Lorenzo Lewis
cd2045d10f Fix CLI links (#900)
* Fix CLI links

* Fix path

* Patch generated doc
2022-09-16 13:27:21 +01:00
tauri
aeb5c23888 chore(docs): Update Rust & TS docs (#895)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-09-15 19:00:43 +02:00
Lorenzo Lewis
6d70a064a1 Fix/js docs escaped characters (#887)
* Update update-docs.yml

* Add package to generate docs

* Switch repos where docs are generated

* Test repo integration

* Temporarily disable any rusty stuffs

* Save docs as artifacts

* .gitignore trailing whitespace

* Switch to our custom repo

* Fix typedoc plugin path

* Start to put the repo back together

* Remove old, commented out code

* Update navbar and sidebar for updated JS path

* Remove old JS API files

* Add newly generated JS API files

* Run patch

* Fix broken links

* Add in typedoc-plugin-mdn-links

* Pin dep

* Update with markdown changes

* Add option to hide the horizontal divider on a page

* Update doc formatting

* Add `excludePrivate` to hide private window property

* Update tables to include row links

* Embed titles in backticks

* Fix output dir

* Fix json output

* Set docs to output directly to tauri-docs dir

* Update docs

* Fix whitespace in tables

* Updated docs for @amrbashir <3

* CSS makes @amrbashir a happy boy

* Update deps

* Update docs

* Add redirects for old modules, classes, enums, and interfaces routes

* Don't splat those redirects

* Update netlify.toml

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>

* Remove old CSS and make minimum heading size an h4

* Fix escaped characters

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
2022-09-14 20:06:45 +01:00
Lorenzo Lewis
77f6c8a356 Update JS Doc Generation (#869)
* Update update-docs.yml

* Add package to generate docs

* Switch repos where docs are generated

* Test repo integration

* Temporarily disable any rusty stuffs

* Save docs as artifacts

* .gitignore trailing whitespace

* Switch to our custom repo

* Fix typedoc plugin path

* Start to put the repo back together

* Remove old, commented out code

* Update navbar and sidebar for updated JS path

* Remove old JS API files

* Add newly generated JS API files

* Run patch

* Fix broken links

* Add in typedoc-plugin-mdn-links

* Pin dep

* Update with markdown changes

* Add option to hide the horizontal divider on a page

* Update doc formatting

* Add `excludePrivate` to hide private window property

* Update tables to include row links

* Embed titles in backticks

* Fix output dir

* Fix json output

* Set docs to output directly to tauri-docs dir

* Update docs

* Fix whitespace in tables

* Updated docs for @amrbashir <3

* CSS makes @amrbashir a happy boy

* Update deps

* Update docs

* Add redirects for old modules, classes, enums, and interfaces routes

* Don't splat those redirects

* Update netlify.toml

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>

* Remove old CSS and make minimum heading size an h4

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
2022-09-13 17:02:31 +01:00
Amr Bashir
f4138e511a fix generating linked array type in config generation (#808)
* fix generating linked array type in config generation

* generate new config

* apply link to the type only without []

* again

* revert! my disappointment is immeasurable and my day is ruined
2022-08-09 10:25:35 +01:00
tauri
e658321ece chore(docs): Update Rust & TS docs (#794)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-07-24 09:53:38 +02:00
Lorenzo Lewis
514b66e3a4 Revise links, minor codeblock formatting (#777) 2022-07-16 20:02:11 +01:00
tauri
6ffe6516d8 chore(docs): Update Rust & TS docs (#770)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-07-15 12:00:05 +02:00
tauri
9708f2c804 chore(docs): Update Rust & TS docs (#756)
Co-authored-by: lorenzolewis <lorenzolewis@users.noreply.github.com>
2022-07-11 18:09:42 +01:00
tauri
abd6327676 Update Docs (#742)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-07-06 15:54:53 -03:00
tauri
881638cb2e chore(docs): Update Rust & TS docs (#719)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-07-03 23:55:34 +01:00
Lorenzo Lewis
a600c59eb9 Remove all rust docs (#725) 2022-07-03 23:55:17 +01:00
Lucas Fernandes Nogueira
c977eff09e fix(config): adjust inner object parsing (#723)
Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>
2022-07-03 19:46:46 -03:00
tauri
a1750a2c55 chore(docs): Update Rust & TS docs (#717)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-06-29 21:06:34 +01:00
Imad Bouziani
e5d543d2a8 update documentation for config.bundle.identifier chars constraint (#659) 2022-06-16 11:17:37 +02:00
tauri
8fed8314d5 chore(docs): Update Rust & TS docs (#656)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-06-16 10:50:32 +02:00
tauri
e5d3328593 chore(docs): Update Rust & TS docs (#650)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-06-14 22:28:38 -03:00
tauri
362bf62725 chore(docs): Update Rust & TS docs (#646)
Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>
2022-06-14 15:40:19 +02:00
tauri
76c8118032 Update Docs (#645)
* chore(docs): Update Rust & TS docs

* revert #644

Co-authored-by: FabianLars <FabianLars@users.noreply.github.com>
Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
2022-06-14 15:08:14 +02:00
Lorenzo Lewis
1211f9359f Feat/guides/building (#631)
* Remove number prefix for guides

* Add windows installer guide

* Update docs/guides/building/windows-installer.md

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>

* Add macOS bundle guide

* Add console to codetype

* Update docs/guides/building/windows-installer.md

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>

* Update docs/guides/building/windows-installer.md

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>

* Remove bootstrapper

* Add revised app size doc

* Fix links

* Create guides index page

* add tauri build fragment to building docs

* add cross-comp notice

* Rename guide files

* Fix sidebar positions

* Mark fragment as draft

* Test netlify build

* Manually add files with _ to not render

* Make pluralisation similar

* Add cross-platform WIP text

* Move debugging section up

* re-enable shell prefix through css

* turn code snippet into powershell

* update all code blocks to use css prefix

* fix: css shell prefix with multiline snippets

* Update updating-dependencies.md

* Minor heading and typo fixes

* Change intro to a readme so it's anchored at root

* Remove comment

* Add newline

* Let prettier do its thing

* Add powershell and bash as languages (includes shell)

* Update docs/guides/building/README.md

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>

* Add link to api for beforeBuildCommand

* Fix grammer

* Remove outdated Bootstrapper section

* Add in note about `fix-path-env-rs`

Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
Co-authored-by: Jonas Kruckenberg <iterpre@protonmail.com>
2022-05-31 21:11:13 +01:00