From eea519224eb904d22cb90c81513c4d32f9ac3122 Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Tue, 19 Jul 2022 21:42:29 +1000 Subject: [PATCH] Fix docs again! --- website/docs/gettingstarted/firstproject.mdx | 75 +------------ website/docs/gettingstarted/installation.mdx | 34 +----- website/src/components/frameworktabs.js | 100 +++++++++--------- website/src/components/tabinstall.js | 64 +++++------ .../gettingstarted/firstproject.mdx | 72 +------------ .../gettingstarted/installation.mdx | 4 +- .../gettingstarted/firstproject.mdx | 71 +------------ .../gettingstarted/installation.mdx | 36 +------ 8 files changed, 95 insertions(+), 361 deletions(-) diff --git a/website/docs/gettingstarted/firstproject.mdx b/website/docs/gettingstarted/firstproject.mdx index 2884df1ad..3af3ed856 100644 --- a/website/docs/gettingstarted/firstproject.mdx +++ b/website/docs/gettingstarted/firstproject.mdx @@ -10,79 +10,8 @@ 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"; - - - - 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 - - - +import TabsFrameworks from "../../src/components/frameworktabs"; +
diff --git a/website/docs/gettingstarted/installation.mdx b/website/docs/gettingstarted/installation.mdx index f69c9ef50..b1dd17d9d 100644 --- a/website/docs/gettingstarted/installation.mdx +++ b/website/docs/gettingstarted/installation.mdx @@ -37,38 +37,8 @@ Run `npm --version` to verify. You will also need to install platform specific dependencies: - -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. - - - - +import TabsInstaller from "../../src/components/tabinstall"; + ## Optional Dependencies diff --git a/website/src/components/frameworktabs.js b/website/src/components/frameworktabs.js index 571eb33c5..69abb1cf0 100644 --- a/website/src/components/frameworktabs.js +++ b/website/src/components/frameworktabs.js @@ -1,77 +1,77 @@ - import React from 'react'; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; export default function TabsFrameworks() { return ( +//@formatter:off + + + Generate a Svelte project using Javascript with:
- - - Generate a Svelte project using Javascript with:
+ wails init -n myproject -t svelte - wails init -n myproject -t svelte + If you would rather use Typescript: - 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 svelte-ts - - - Generate a React project using Javascript with:
+ wails init -n myproject -t react - wails init -n myproject -t react + If you would rather use Typescript: - 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 react-ts - - - Generate a Vue project using Javascript with:
+ wails init -n myproject -t vue - wails init -n myproject -t vue + If you would rather use Typescript: - 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 vue-ts - - - Generate a Preact project using Javascript with:
+ wails init -n myproject -t preact - wails init -n myproject -t preact + If you would rather use Typescript: - 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 preact-ts - - - Generate a Lit project using Javascript with:
+ wails init -n myproject -t lit - wails init -n myproject -t lit + If you would rather use Typescript: - 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 lit-ts - - - Generate a Vanilla project using Javascript with:
+ wails init -n myproject -t vanilla - wails init -n myproject -t vanilla + If you would rather use Typescript: - If you would rather use Typescript: - - wails init -n myproject -t vanilla-ts - - + wails init -n myproject -t vanilla-ts + + +//@formatter:on ) } diff --git a/website/src/components/tabinstall.js b/website/src/components/tabinstall.js index 71a723db1..a8b5c00fd 100644 --- a/website/src/components/tabinstall.js +++ b/website/src/components/tabinstall.js @@ -2,40 +2,42 @@ import React from 'react'; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -export default function TabInstall() { +export default function TabsInstaller() { return ( - - - Wails requires that the xcode command line tools are installed. This can be done by running:
+//@formatter:off + + + 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. + 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. - + - + +//@formatter:off ) } 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 7a8a371c6..6bc9051f2 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,76 +11,8 @@ 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"; - - - - 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 - - - +import TabsFrameworks from "../../../src/components/frameworktabs"; +
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 a670e3240..4c3c0cde9 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,8 +37,8 @@ Run `npm --version` to verify. You will also need to install platform specific dependencies: -import TabInstall from '../../../src/components/tabinstall'; - +import TabsInstaller from "../../../src/components/tabinstall"; + ## Optional Dependencies 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 6f5c0b55c..4d0674718 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,75 +10,8 @@ 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"; - - - - 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 - - +import TabsFrameworks from "../../../src/components/frameworktabs"; +
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 d5a538d5a..77e5e8372 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 @@ -37,42 +37,10 @@ Run `npm --version` to verify. You will also need to install platform specific dependencies: +import TabsInstaller 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 - [UPX](https://upx.github.io/) for compressing your applications.