Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Vic Shóstak committed Feb 22, 2024
1 parent e57455c commit 12ab1dc
Show file tree
Hide file tree
Showing 27 changed files with 107 additions and 41 deletions.
2 changes: 1 addition & 1 deletion docs/complete-user-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/es/complete-user-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/es/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ next:

The most common questions that may come up when using the **Gowebly** CLI are collected in this section.

<!--@include: ../parts/block_cant-find-answer.md-->
<!--@include: ../parts/es/block_cant-find-answer.md-->

## What is the right way to ask a question or report a bug?

Expand Down
2 changes: 1 addition & 1 deletion docs/es/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ lastUpdated: false

This section will help you understand what **Gowebly** CLI is.

<!--@include: ../../parts/block_want-to-try.md-->
<!--@include: ../parts/es/block_want-to-try.md-->

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.

Expand Down
10 changes: 9 additions & 1 deletion docs/es/getting-started/how-does-it-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ lastUpdated: false

This section will help you understand how **Gowebly** CLI works.

<!--@include: ../../parts/block_want-to-try.md-->
<!--@include: ../../parts/es/block_want-to-try.md-->

The **Gowebly** CLI is built on top of the [Go][go_url] programming language.

Expand All @@ -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.
Expand All @@ -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.
Expand Down
16 changes: 12 additions & 4 deletions docs/es/getting-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Here's a minimal version of the steps to run the **Gowebly** CLI.

<!--@include: ../../parts/block_cant-find-answer.md-->
<!--@include: ../../parts/es/block_cant-find-answer.md-->

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:

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/es/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/es/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev:

The most common malfunctions that may come up when using the **Gowebly** CLI.

<!--@include: ../parts/block_cant-find-answer.md-->
<!--@include: ../parts/es/block_cant-find-answer.md-->

## Port X is taken by OS

Expand Down
8 changes: 8 additions & 0 deletions docs/getting-started/how-does-it-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
14 changes: 11 additions & 3 deletions docs/getting-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Here's a minimal version of the steps to run the **Gowebly** CLI.

<!--@include: ../parts/block_cant-find-answer.md-->

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:

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 2 additions & 0 deletions docs/parts/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- Frontend links -->

Expand Down
2 changes: 1 addition & 1 deletion docs/ru/complete-user-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/ru/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ next:

The most common questions that may come up when using the **Gowebly** CLI are collected in this section.

<!--@include: ../parts/block_cant-find-answer.md-->
<!--@include: ../parts/ru/block_cant-find-answer.md-->

## What is the right way to ask a question or report a bug?

Expand Down
2 changes: 1 addition & 1 deletion docs/ru/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ lastUpdated: false

This section will help you understand what **Gowebly** CLI is.

<!--@include: ../parts/block_want-to-try.md-->
<!--@include: ../parts/ru/block_want-to-try.md-->

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.

Expand Down
10 changes: 9 additions & 1 deletion docs/ru/getting-started/how-does-it-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ lastUpdated: false

This section will help you understand how **Gowebly** CLI works.

<!--@include: ../../parts/block_want-to-try.md-->
<!--@include: ../../parts/ru/block_want-to-try.md-->

The **Gowebly** CLI is built on top of the [Go][go_url] programming language.

Expand All @@ -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.
Expand All @@ -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.
Expand Down
16 changes: 12 additions & 4 deletions docs/ru/getting-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Here's a minimal version of the steps to run the **Gowebly** CLI.

<!--@include: ../../parts/block_cant-find-answer.md-->
<!--@include: ../../parts/ru/block_cant-find-answer.md-->

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:

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/ru/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/ru/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ prev:

The most common malfunctions that may come up when using the **Gowebly** CLI.

<!--@include: ../parts/block_cant-find-answer.md-->
<!--@include: ../parts/ru/block_cant-find-answer.md-->

## Port X is taken by OS

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_HK/complete-user-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_HK/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ next:

The most common questions that may come up when using the **Gowebly** CLI are collected in this section.

<!--@include: ../parts/block_cant-find-answer.md-->
<!--@include: ../parts/zh_HK/block_cant-find-answer.md-->

## What is the right way to ask a question or report a bug?

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_HK/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ lastUpdated: false

This section will help you understand what **Gowebly** CLI is.

<!--@include: ../parts/block_want-to-try.md-->
<!--@include: ../parts/zh_HK/block_want-to-try.md-->

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.

Expand Down
10 changes: 9 additions & 1 deletion docs/zh_HK/getting-started/how-does-it-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ lastUpdated: false

This section will help you understand how **Gowebly** CLI works.

<!--@include: ../../parts/block_want-to-try.md-->
<!--@include: ../../parts/zh_HK/block_want-to-try.md-->

The **Gowebly** CLI is built on top of the [Go][go_url] programming language.

Expand All @@ -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.
Expand All @@ -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.
Expand Down
16 changes: 12 additions & 4 deletions docs/zh_HK/getting-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Here's a minimal version of the steps to run the **Gowebly** CLI.

<!--@include: ../../parts/block_cant-find-answer.md-->
<!--@include: ../../parts/zh_HK/block_cant-find-answer.md-->

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:

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_HK/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading

0 comments on commit 12ab1dc

Please sign in to comment.