From 12ab1dc62c5f0e7c2414462792147a73cc824d8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vic=20Sh=C3=B3stak?= Date: Thu, 22 Feb 2024 11:16:28 +0300 Subject: [PATCH] Update docs --- docs/complete-user-guide/installation.md | 2 +- docs/es/complete-user-guide/installation.md | 2 +- docs/es/faq.md | 2 +- docs/es/getting-started.md | 2 +- docs/es/getting-started/how-does-it-work.md | 10 +++++++++- docs/es/getting-started/quick-start-guide.md | 16 ++++++++++++---- docs/es/index.md | 2 +- docs/es/troubleshooting.md | 2 +- docs/getting-started/how-does-it-work.md | 8 ++++++++ docs/getting-started/quick-start-guide.md | 14 +++++++++++--- docs/index.md | 2 +- docs/parts/links.md | 2 ++ docs/ru/complete-user-guide/installation.md | 2 +- docs/ru/faq.md | 2 +- docs/ru/getting-started.md | 2 +- docs/ru/getting-started/how-does-it-work.md | 10 +++++++++- docs/ru/getting-started/quick-start-guide.md | 16 ++++++++++++---- docs/ru/index.md | 2 +- docs/ru/troubleshooting.md | 2 +- docs/zh_HK/complete-user-guide/installation.md | 2 +- docs/zh_HK/faq.md | 2 +- docs/zh_HK/getting-started.md | 2 +- docs/zh_HK/getting-started/how-does-it-work.md | 10 +++++++++- docs/zh_HK/getting-started/quick-start-guide.md | 16 ++++++++++++---- docs/zh_HK/index.md | 2 +- docs/zh_HK/troubleshooting.md | 2 +- package.json | 12 ++++++------ 27 files changed, 107 insertions(+), 41 deletions(-) diff --git a/docs/complete-user-guide/installation.md b/docs/complete-user-guide/installation.md index ef52be0..fbf64cf 100644 --- a/docs/complete-user-guide/installation.md +++ b/docs/complete-user-guide/installation.md @@ -4,7 +4,7 @@ The basics for installing the **Gowebly** CLI on your system are covered in this ## Go -[Download][go_download_url] and install **Go**. Version `1.21` (or higher) is required. +[Download][go_download_url] and install **Go**. Version `1.22` (or higher) is required. Then, use the [`go install`][go_install_url] command: diff --git a/docs/es/complete-user-guide/installation.md b/docs/es/complete-user-guide/installation.md index 9cf9e81..6de8fbe 100644 --- a/docs/es/complete-user-guide/installation.md +++ b/docs/es/complete-user-guide/installation.md @@ -4,7 +4,7 @@ The basics for installing the **Gowebly** CLI on your system are covered in this ## Go -[Download][go_download_url] and install **Go**. Version `1.21` (or higher) is required. +[Download][go_download_url] and install **Go**. Version `1.22` (or higher) is required. Then, use the [`go install`][go_install_url] command: diff --git a/docs/es/faq.md b/docs/es/faq.md index a6b4af0..b87e6ec 100644 --- a/docs/es/faq.md +++ b/docs/es/faq.md @@ -11,7 +11,7 @@ next: The most common questions that may come up when using the **Gowebly** CLI are collected in this section. - + ## What is the right way to ask a question or report a bug? diff --git a/docs/es/getting-started.md b/docs/es/getting-started.md index b4b08bb..d5e8f7a 100644 --- a/docs/es/getting-started.md +++ b/docs/es/getting-started.md @@ -7,7 +7,7 @@ lastUpdated: false This section will help you understand what **Gowebly** CLI is. - + The **Gowebly** CLI is a free and open source software that helps to easily build amazing web applications with Go on the backend, using htmx & hyperscript and the most popular CSS frameworks on the frontend. diff --git a/docs/es/getting-started/how-does-it-work.md b/docs/es/getting-started/how-does-it-work.md index a4b9206..745ad85 100644 --- a/docs/es/getting-started/how-does-it-work.md +++ b/docs/es/getting-started/how-does-it-work.md @@ -7,7 +7,7 @@ lastUpdated: false This section will help you understand how **Gowebly** CLI works. - + The **Gowebly** CLI is built on top of the [Go][go_url] programming language. @@ -33,6 +33,10 @@ To be more efficient, the CLI supports the [Templ][backend_a_h_templ_url] templa All templates are regular Go functions, without having to create additional HTML templates and deal with the built-in Go templating engine (from the `html/template` package). +### Linter for Go code + +To make the code cleaner, we give the option to generate the [golangci-lint][backend_golangci_lint_url] configuration file with recommended settings. This is optional, but highly recommended. + ## Frontend part To create a build for the **frontend** part, the quick and easy [Parcel][frontend_parcel_url] bundler version `2` was chosen. This allowed us to reduce the unnecessarily stressful moment of frontend build to the maximum. @@ -55,6 +59,10 @@ The [htmx][frontend_htmx_url], [hyperscript][frontend_hyperscript_url] and [Alpi Since `v2.0.0`, the **Gowebly** CLI supports the [Prettier][frontend_prettier_url] formatter to format your files. +## Live-reload + +The **Gowebly** CLI supports the **live-reload** feature by the [Air][backend_air_url] tool. This works the same for both backend Go files and frontend files (JavaScript, CSS and so on). + ## Deploy To successfully **deploy** your project to a remote server (or in the cloud), the CLI has pre-prepared Docker files (`docker-compose.yml` and `Dockerfile`). They already contain all the settings you need to create an isolated container exactly with your project. diff --git a/docs/es/getting-started/quick-start-guide.md b/docs/es/getting-started/quick-start-guide.md index 82ea76c..1f47ebb 100644 --- a/docs/es/getting-started/quick-start-guide.md +++ b/docs/es/getting-started/quick-start-guide.md @@ -2,9 +2,9 @@ Here's a minimal version of the steps to run the **Gowebly** CLI. - + -First, [download][go_download_url] and install **Go**. Version `1.21` (or higher) is required. +First, [download][go_download_url] and install **Go**. Version `1.22` (or higher) is required. Run the [`go run`][go_run_url] command to create a new project in the current folder: @@ -16,9 +16,17 @@ go run github.com/gowebly/gowebly/v2@latest create With `go run`, you can use all features of the **Gowebly** CLI without installation to your system. ::: -That's it! :fire: +That's it! :fire: A web application has been created in the current folder. -A web application has been created in the current folder. It will use the **net/http** package (as a Go backend) and the **html/template** package (as a template engine). The **htmx** and **hyperscript** packages are already available in your HTML templates. +You can check which of the recommended tools are already installed on your system by using the `doctor` utility built into the **Gowebly** CLI: + +``` bash +go run github.com/gowebly/gowebly/v2@latest doctor +``` + +If some tools are not installed, it is recommended that you install them yourself. Especially **Node.js** (or **Bun**) for building frontend parts of your application. + +Now you can start developing your web application. ## Use a ready-made packages diff --git a/docs/es/index.md b/docs/es/index.md index 9a31871..91b8c43 100644 --- a/docs/es/index.md +++ b/docs/es/index.md @@ -4,7 +4,7 @@ layout: home hero: name: Gowebly text: Una herramienta CLI de última generación para crear aplicaciones web increíbles. - tagline: Go, htmx & hyperscript, ¡marcos CSS modernos! + tagline: Go, htmx, ¡marcos CSS modernos! image: src: /gowebly-logo.svg alt: "gowebly logo" diff --git a/docs/es/troubleshooting.md b/docs/es/troubleshooting.md index 55794d4..1b7c2a4 100644 --- a/docs/es/troubleshooting.md +++ b/docs/es/troubleshooting.md @@ -8,7 +8,7 @@ prev: The most common malfunctions that may come up when using the **Gowebly** CLI. - + ## Port X is taken by OS diff --git a/docs/getting-started/how-does-it-work.md b/docs/getting-started/how-does-it-work.md index 80924a6..133bd39 100644 --- a/docs/getting-started/how-does-it-work.md +++ b/docs/getting-started/how-does-it-work.md @@ -33,6 +33,10 @@ To be more efficient, the CLI supports the [Templ][backend_a_h_templ_url] templa All templates are regular Go functions, without having to create additional HTML templates and deal with the built-in Go templating engine (from the `html/template` package). +### Linter for Go code + +To make the code cleaner, we give the option to generate the [golangci-lint][backend_golangci_lint_url] configuration file with recommended settings. This is optional, but highly recommended. + ## Frontend part To create a build for the **frontend** part, the quick and easy [Parcel][frontend_parcel_url] bundler version `2` was chosen. This allowed us to reduce the unnecessarily stressful moment of frontend build to the maximum. @@ -55,6 +59,10 @@ The [htmx][frontend_htmx_url], [hyperscript][frontend_hyperscript_url] and [Alpi Since `v2.0.0`, the **Gowebly** CLI supports the [Prettier][frontend_prettier_url] formatter to format your files. +## Live-reload + +The **Gowebly** CLI supports the **live-reload** feature by the [Air][backend_air_url] tool. This works the same for both backend Go files and frontend files (JavaScript, CSS and so on). + ## Deploy To successfully **deploy** your project to a remote server (or in the cloud), the CLI has pre-prepared Docker files (`docker-compose.yml` and `Dockerfile`). They already contain all the settings you need to create an isolated container exactly with your project. diff --git a/docs/getting-started/quick-start-guide.md b/docs/getting-started/quick-start-guide.md index 18f3771..261cf06 100644 --- a/docs/getting-started/quick-start-guide.md +++ b/docs/getting-started/quick-start-guide.md @@ -4,7 +4,7 @@ Here's a minimal version of the steps to run the **Gowebly** CLI. -First, [download][go_download_url] and install **Go**. Version `1.21` (or higher) is required. +First, [download][go_download_url] and install **Go**. Version `1.22` (or higher) is required. Run the [`go run`][go_run_url] command to create a new project in the current folder: @@ -16,9 +16,17 @@ go run github.com/gowebly/gowebly/v2@latest create With `go run`, you can use all features of the **Gowebly** CLI without installation to your system. ::: -That's it! :fire: +That's it! :fire: A web application has been created in the current folder. -A web application has been created in the current folder. It will use the **net/http** package (as a Go backend) and the **html/template** package (as a template engine). The **htmx** and **hyperscript** packages are already available in your HTML templates. +You can check which of the recommended tools are already installed on your system by using the `doctor` utility built into the **Gowebly** CLI: + +``` bash +go run github.com/gowebly/gowebly/v2@latest doctor +``` + +If some tools are not installed, it is recommended that you install them yourself. Especially **Node.js** (or **Bun**) for building frontend parts of your application. + +Now you can start developing your web application. ## Use a ready-made packages diff --git a/docs/index.md b/docs/index.md index 5e81c2d..baff7d3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ layout: home hero: name: Gowebly text: A next-generation CLI tool for build amazing web apps. - tagline: Go, htmx & hyperscript, modern CSS frameworks! + tagline: Go, htmx, modern CSS frameworks! image: src: /gowebly-logo.svg alt: "gowebly logo" diff --git a/docs/parts/links.md b/docs/parts/links.md index 172f3c4..e5b3cc1 100644 --- a/docs/parts/links.md +++ b/docs/parts/links.md @@ -26,6 +26,8 @@ [backend_httprouter_url]: https://github.com/julienschmidt/httprouter [backend_a_h_templ_url]: https://github.com/a-h/templ [backend_angelofallars_go_htmx_url]: https://github.com/angelofallars/htmx-go +[backend_golangci_lint_url]: https://github.com/golangci/golangci-lint +[backend_air_url]: https://github.com/cosmtrek/air diff --git a/docs/ru/complete-user-guide/installation.md b/docs/ru/complete-user-guide/installation.md index 9cf9e81..6de8fbe 100644 --- a/docs/ru/complete-user-guide/installation.md +++ b/docs/ru/complete-user-guide/installation.md @@ -4,7 +4,7 @@ The basics for installing the **Gowebly** CLI on your system are covered in this ## Go -[Download][go_download_url] and install **Go**. Version `1.21` (or higher) is required. +[Download][go_download_url] and install **Go**. Version `1.22` (or higher) is required. Then, use the [`go install`][go_install_url] command: diff --git a/docs/ru/faq.md b/docs/ru/faq.md index cd20a4a..ffae83a 100644 --- a/docs/ru/faq.md +++ b/docs/ru/faq.md @@ -11,7 +11,7 @@ next: The most common questions that may come up when using the **Gowebly** CLI are collected in this section. - + ## What is the right way to ask a question or report a bug? diff --git a/docs/ru/getting-started.md b/docs/ru/getting-started.md index 53bbf95..9450069 100644 --- a/docs/ru/getting-started.md +++ b/docs/ru/getting-started.md @@ -7,7 +7,7 @@ lastUpdated: false This section will help you understand what **Gowebly** CLI is. - + The **Gowebly** CLI is a free and open source software that helps to easily build amazing web applications with Go on the backend, using htmx & hyperscript and the most popular CSS frameworks on the frontend. diff --git a/docs/ru/getting-started/how-does-it-work.md b/docs/ru/getting-started/how-does-it-work.md index a4b9206..0405d4f 100644 --- a/docs/ru/getting-started/how-does-it-work.md +++ b/docs/ru/getting-started/how-does-it-work.md @@ -7,7 +7,7 @@ lastUpdated: false This section will help you understand how **Gowebly** CLI works. - + The **Gowebly** CLI is built on top of the [Go][go_url] programming language. @@ -33,6 +33,10 @@ To be more efficient, the CLI supports the [Templ][backend_a_h_templ_url] templa All templates are regular Go functions, without having to create additional HTML templates and deal with the built-in Go templating engine (from the `html/template` package). +### Linter for Go code + +To make the code cleaner, we give the option to generate the [golangci-lint][backend_golangci_lint_url] configuration file with recommended settings. This is optional, but highly recommended. + ## Frontend part To create a build for the **frontend** part, the quick and easy [Parcel][frontend_parcel_url] bundler version `2` was chosen. This allowed us to reduce the unnecessarily stressful moment of frontend build to the maximum. @@ -55,6 +59,10 @@ The [htmx][frontend_htmx_url], [hyperscript][frontend_hyperscript_url] and [Alpi Since `v2.0.0`, the **Gowebly** CLI supports the [Prettier][frontend_prettier_url] formatter to format your files. +## Live-reload + +The **Gowebly** CLI supports the **live-reload** feature by the [Air][backend_air_url] tool. This works the same for both backend Go files and frontend files (JavaScript, CSS and so on). + ## Deploy To successfully **deploy** your project to a remote server (or in the cloud), the CLI has pre-prepared Docker files (`docker-compose.yml` and `Dockerfile`). They already contain all the settings you need to create an isolated container exactly with your project. diff --git a/docs/ru/getting-started/quick-start-guide.md b/docs/ru/getting-started/quick-start-guide.md index 82ea76c..23c4f0e 100644 --- a/docs/ru/getting-started/quick-start-guide.md +++ b/docs/ru/getting-started/quick-start-guide.md @@ -2,9 +2,9 @@ Here's a minimal version of the steps to run the **Gowebly** CLI. - + -First, [download][go_download_url] and install **Go**. Version `1.21` (or higher) is required. +First, [download][go_download_url] and install **Go**. Version `1.22` (or higher) is required. Run the [`go run`][go_run_url] command to create a new project in the current folder: @@ -16,9 +16,17 @@ go run github.com/gowebly/gowebly/v2@latest create With `go run`, you can use all features of the **Gowebly** CLI without installation to your system. ::: -That's it! :fire: +That's it! :fire: A web application has been created in the current folder. -A web application has been created in the current folder. It will use the **net/http** package (as a Go backend) and the **html/template** package (as a template engine). The **htmx** and **hyperscript** packages are already available in your HTML templates. +You can check which of the recommended tools are already installed on your system by using the `doctor` utility built into the **Gowebly** CLI: + +``` bash +go run github.com/gowebly/gowebly/v2@latest doctor +``` + +If some tools are not installed, it is recommended that you install them yourself. Especially **Node.js** (or **Bun**) for building frontend parts of your application. + +Now you can start developing your web application. ## Use a ready-made packages diff --git a/docs/ru/index.md b/docs/ru/index.md index 2b82609..10351b2 100644 --- a/docs/ru/index.md +++ b/docs/ru/index.md @@ -4,7 +4,7 @@ layout: home hero: name: Gowebly text: CLI-инструмент нового поколения для создания потрясающих веб-приложений. - tagline: Go, htmx & hyperscript, современные CSS-фреймворки! + tagline: Go, htmx, современные CSS-фреймворки! image: src: /gowebly-logo.svg alt: "gowebly logo" diff --git a/docs/ru/troubleshooting.md b/docs/ru/troubleshooting.md index d8b9ae2..93e8141 100644 --- a/docs/ru/troubleshooting.md +++ b/docs/ru/troubleshooting.md @@ -8,7 +8,7 @@ prev: The most common malfunctions that may come up when using the **Gowebly** CLI. - + ## Port X is taken by OS diff --git a/docs/zh_HK/complete-user-guide/installation.md b/docs/zh_HK/complete-user-guide/installation.md index 9cf9e81..6de8fbe 100644 --- a/docs/zh_HK/complete-user-guide/installation.md +++ b/docs/zh_HK/complete-user-guide/installation.md @@ -4,7 +4,7 @@ The basics for installing the **Gowebly** CLI on your system are covered in this ## Go -[Download][go_download_url] and install **Go**. Version `1.21` (or higher) is required. +[Download][go_download_url] and install **Go**. Version `1.22` (or higher) is required. Then, use the [`go install`][go_install_url] command: diff --git a/docs/zh_HK/faq.md b/docs/zh_HK/faq.md index c113dfb..47ca015 100644 --- a/docs/zh_HK/faq.md +++ b/docs/zh_HK/faq.md @@ -11,7 +11,7 @@ next: The most common questions that may come up when using the **Gowebly** CLI are collected in this section. - + ## What is the right way to ask a question or report a bug? diff --git a/docs/zh_HK/getting-started.md b/docs/zh_HK/getting-started.md index 53bbf95..264b4a5 100644 --- a/docs/zh_HK/getting-started.md +++ b/docs/zh_HK/getting-started.md @@ -7,7 +7,7 @@ lastUpdated: false This section will help you understand what **Gowebly** CLI is. - + The **Gowebly** CLI is a free and open source software that helps to easily build amazing web applications with Go on the backend, using htmx & hyperscript and the most popular CSS frameworks on the frontend. diff --git a/docs/zh_HK/getting-started/how-does-it-work.md b/docs/zh_HK/getting-started/how-does-it-work.md index a4b9206..edd6901 100644 --- a/docs/zh_HK/getting-started/how-does-it-work.md +++ b/docs/zh_HK/getting-started/how-does-it-work.md @@ -7,7 +7,7 @@ lastUpdated: false This section will help you understand how **Gowebly** CLI works. - + The **Gowebly** CLI is built on top of the [Go][go_url] programming language. @@ -33,6 +33,10 @@ To be more efficient, the CLI supports the [Templ][backend_a_h_templ_url] templa All templates are regular Go functions, without having to create additional HTML templates and deal with the built-in Go templating engine (from the `html/template` package). +### Linter for Go code + +To make the code cleaner, we give the option to generate the [golangci-lint][backend_golangci_lint_url] configuration file with recommended settings. This is optional, but highly recommended. + ## Frontend part To create a build for the **frontend** part, the quick and easy [Parcel][frontend_parcel_url] bundler version `2` was chosen. This allowed us to reduce the unnecessarily stressful moment of frontend build to the maximum. @@ -55,6 +59,10 @@ The [htmx][frontend_htmx_url], [hyperscript][frontend_hyperscript_url] and [Alpi Since `v2.0.0`, the **Gowebly** CLI supports the [Prettier][frontend_prettier_url] formatter to format your files. +## Live-reload + +The **Gowebly** CLI supports the **live-reload** feature by the [Air][backend_air_url] tool. This works the same for both backend Go files and frontend files (JavaScript, CSS and so on). + ## Deploy To successfully **deploy** your project to a remote server (or in the cloud), the CLI has pre-prepared Docker files (`docker-compose.yml` and `Dockerfile`). They already contain all the settings you need to create an isolated container exactly with your project. diff --git a/docs/zh_HK/getting-started/quick-start-guide.md b/docs/zh_HK/getting-started/quick-start-guide.md index 82ea76c..5ce8497 100644 --- a/docs/zh_HK/getting-started/quick-start-guide.md +++ b/docs/zh_HK/getting-started/quick-start-guide.md @@ -2,9 +2,9 @@ Here's a minimal version of the steps to run the **Gowebly** CLI. - + -First, [download][go_download_url] and install **Go**. Version `1.21` (or higher) is required. +First, [download][go_download_url] and install **Go**. Version `1.22` (or higher) is required. Run the [`go run`][go_run_url] command to create a new project in the current folder: @@ -16,9 +16,17 @@ go run github.com/gowebly/gowebly/v2@latest create With `go run`, you can use all features of the **Gowebly** CLI without installation to your system. ::: -That's it! :fire: +That's it! :fire: A web application has been created in the current folder. -A web application has been created in the current folder. It will use the **net/http** package (as a Go backend) and the **html/template** package (as a template engine). The **htmx** and **hyperscript** packages are already available in your HTML templates. +You can check which of the recommended tools are already installed on your system by using the `doctor` utility built into the **Gowebly** CLI: + +``` bash +go run github.com/gowebly/gowebly/v2@latest doctor +``` + +If some tools are not installed, it is recommended that you install them yourself. Especially **Node.js** (or **Bun**) for building frontend parts of your application. + +Now you can start developing your web application. ## Use a ready-made packages diff --git a/docs/zh_HK/index.md b/docs/zh_HK/index.md index f6065b8..198ae4d 100644 --- a/docs/zh_HK/index.md +++ b/docs/zh_HK/index.md @@ -4,7 +4,7 @@ layout: home hero: name: Gowebly text: 下一代 CLI 工具，用于构建令人惊叹的网络应用程序。 - tagline: Go、htmx 和 hyperscript、现代 CSS 框架！ + tagline: Go、htmx、现代 CSS 框架！ image: src: /gowebly-logo.svg alt: "gowebly logo" diff --git a/docs/zh_HK/troubleshooting.md b/docs/zh_HK/troubleshooting.md index 919004c..7d91193 100644 --- a/docs/zh_HK/troubleshooting.md +++ b/docs/zh_HK/troubleshooting.md @@ -8,7 +8,7 @@ prev: The most common malfunctions that may come up when using the **Gowebly** CLI. - + ## Port X is taken by OS diff --git a/package.json b/package.json index 73e5f22..28753d2 100644 --- a/package.json +++ b/package.json @@ -9,12 +9,12 @@ "preview": "vitepress preview docs" }, "dependencies": { - "mermaid": "^10.7.0", - "vitepress": "^1.0.0-rc.40", - "vitepress-plugin-mermaid": "^2.0.16", - "vue": "^3.4.15" + "mermaid": "latest", + "vitepress": "latest", + "vitepress-plugin-mermaid": "latest", + "vue": "latest" }, "devDependencies": { - "typescript": "^5.3.3" + "typescript": "latest" } -} \ No newline at end of file +}