diff --git a/website/docs/gettingstarted/firstproject.mdx b/website/docs/gettingstarted/firstproject.mdx index 286033acf..2884df1ad 100644 --- a/website/docs/gettingstarted/firstproject.mdx +++ b/website/docs/gettingstarted/firstproject.mdx @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # Creating a Project ## Project Generation @@ -7,8 +11,78 @@ Now that the CLI is installed, you can generate a new project by using the `wail Pick your favourite framework: -import TabsFrameworks from "../../src/components/frameworktabs"; - + + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + + + + Generate a Svelte project using Javascript with:
+ + wails init -n myproject -t svelte + + If you would rather use Typescript: + + wails init -n myproject -t svelte-ts +
+ + Generate a React project using Javascript with:
+ + wails init -n myproject -t react + + If you would rather use Typescript: + + wails init -n myproject -t react-ts +
+ + Generate a Vue project using Javascript with:
+ + wails init -n myproject -t vue + + If you would rather use Typescript: + + wails init -n myproject -t vue-ts +
+ + Generate a Preact project using Javascript with:
+ + wails init -n myproject -t preact + + If you would rather use Typescript: + + wails init -n myproject -t preact-ts +
+ + Generate a Lit project using Javascript with:
+ + wails init -n myproject -t lit + + If you would rather use Typescript: + + wails init -n myproject -t lit-ts +
+ + Generate a Vanilla project using Javascript with:
+ + wails init -n myproject -t vanilla + + If you would rather use Typescript: + + wails init -n myproject -t vanilla-ts +
+ +

diff --git a/website/docs/gettingstarted/installation.mdx b/website/docs/gettingstarted/installation.mdx index e4adbadc4..f69c9ef50 100644 --- a/website/docs/gettingstarted/installation.mdx +++ b/website/docs/gettingstarted/installation.mdx @@ -38,8 +38,37 @@ Run `npm --version` to verify. You will also need to install platform specific dependencies: -import TabInstall from '../../src/components/tabinstall'; - +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + + + + Wails requires that the xcode command line tools are installed. This can be done by running:
+ + xcode-select --install +
+ + Wails requires that the WebView2{" "} + runtime is installed. Some Windows installations will already have this installed. You can check using the{" "} + wails doctor command (see below). + + + Linux required the standard gcc build tools plus libgtk3 and libwebkit. + Rather than list a ton of commands for different distros, Wails can try to determine + what the installation commands are for your specific distribution. Run wails doctor after installation + to be shown how to install the dependencies. + If your distro/package manager is not supported, please consult the Add Linux Distro guide. + + + +
## Optional Dependencies diff --git a/website/src/components/frameworktabs.js b/website/src/components/frameworktabs.js index ac7c11c05..571eb33c5 100644 --- a/website/src/components/frameworktabs.js +++ b/website/src/components/frameworktabs.js @@ -1,3 +1,4 @@ + import React from 'react'; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; diff --git a/website/versioned_docs/version-v2.0.0-beta.38/gettingstarted/firstproject.mdx b/website/versioned_docs/version-v2.0.0-beta.38/gettingstarted/firstproject.mdx index 6bc9051f2..7a8a371c6 100644 --- a/website/versioned_docs/version-v2.0.0-beta.38/gettingstarted/firstproject.mdx +++ b/website/versioned_docs/version-v2.0.0-beta.38/gettingstarted/firstproject.mdx @@ -11,8 +11,76 @@ Now that the CLI is installed, you can generate a new project by using the `wail Pick your favourite framework: -import TabsFrameworks from "../../../src/components/frameworktabs"; - +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + + + + Generate a Svelte project using Javascript with:
+ + wails init -n myproject -t svelte + + If you would rather use Typescript: + + wails init -n myproject -t svelte-ts +
+ + Generate a React project using Javascript with:
+ + wails init -n myproject -t react + + If you would rather use Typescript: + + wails init -n myproject -t react-ts +
+ + Generate a Vue project using Javascript with:
+ + wails init -n myproject -t vue + + If you would rather use Typescript: + + wails init -n myproject -t vue-ts +
+ + Generate a Preact project using Javascript with:
+ + wails init -n myproject -t preact + + If you would rather use Typescript: + + wails init -n myproject -t preact-ts +
+ + Generate a Lit project using Javascript with:
+ + wails init -n myproject -t lit + + If you would rather use Typescript: + + wails init -n myproject -t lit-ts +
+ + Generate a Vanilla project using Javascript with:
+ + wails init -n myproject -t vanilla + + If you would rather use Typescript: + + wails init -n myproject -t vanilla-ts +
+ +

diff --git a/website/versioned_docs/version-v2.0.0-beta.38/gettingstarted/installation.mdx b/website/versioned_docs/version-v2.0.0-beta.38/gettingstarted/installation.mdx index c7cd1f765..a670e3240 100644 --- a/website/versioned_docs/version-v2.0.0-beta.38/gettingstarted/installation.mdx +++ b/website/versioned_docs/version-v2.0.0-beta.38/gettingstarted/installation.mdx @@ -37,7 +37,6 @@ Run `npm --version` to verify. You will also need to install platform specific dependencies: - import TabInstall from '../../../src/components/tabinstall'; diff --git a/website/versioned_docs/version-v2.0.0-beta.39/gettingstarted/firstproject.mdx b/website/versioned_docs/version-v2.0.0-beta.39/gettingstarted/firstproject.mdx index 6bc9051f2..6f5c0b55c 100644 --- a/website/versioned_docs/version-v2.0.0-beta.39/gettingstarted/firstproject.mdx +++ b/website/versioned_docs/version-v2.0.0-beta.39/gettingstarted/firstproject.mdx @@ -10,9 +10,75 @@ Now that the CLI is installed, you can generate a new project by using the `wail Pick your favourite framework: +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -import TabsFrameworks from "../../../src/components/frameworktabs"; - + + + Generate a Svelte project using Javascript with:
+ + wails init -n myproject -t svelte + + If you would rather use Typescript: + + wails init -n myproject -t svelte-ts +
+ + Generate a React project using Javascript with:
+ + wails init -n myproject -t react + + If you would rather use Typescript: + + wails init -n myproject -t react-ts +
+ + Generate a Vue project using Javascript with:
+ + wails init -n myproject -t vue + + If you would rather use Typescript: + + wails init -n myproject -t vue-ts +
+ + Generate a Preact project using Javascript with:
+ + wails init -n myproject -t preact + + If you would rather use Typescript: + + wails init -n myproject -t preact-ts +
+ + Generate a Lit project using Javascript with:
+ + wails init -n myproject -t lit + + If you would rather use Typescript: + + wails init -n myproject -t lit-ts +
+ + Generate a Vanilla project using Javascript with:
+ + wails init -n myproject -t vanilla + + If you would rather use Typescript: + + wails init -n myproject -t vanilla-ts +
+

diff --git a/website/versioned_docs/version-v2.0.0-beta.39/gettingstarted/installation.mdx b/website/versioned_docs/version-v2.0.0-beta.39/gettingstarted/installation.mdx index 32399ef63..d5a538d5a 100644 --- a/website/versioned_docs/version-v2.0.0-beta.39/gettingstarted/installation.mdx +++ b/website/versioned_docs/version-v2.0.0-beta.39/gettingstarted/installation.mdx @@ -38,8 +38,40 @@ Run `npm --version` to verify. You will also need to install platform specific dependencies: -import TabInstall from '../../../src/components/tabinstall'; - + + + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + + + + Wails requires that the xcode command line tools are installed. This can be done by running:
+ + xcode-select --install +
+ + Wails requires that the WebView2{" "} + runtime is installed. Some Windows installations will already have this installed. You can check using the{" "} + wails doctor command (see below). + + + Linux required the standard gcc build tools plus libgtk3 and libwebkit. + Rather than list a ton of commands for different distros, Wails can try to determine + what the installation commands are for your specific distribution. Run wails doctor after installation + to be shown how to install the dependencies. + If your distro/package manager is not supported, please consult the Add Linux Distro guide. + + + +
## Optional Dependencies