htmgo/htmgo-site/pages/docs/installation.go

package docs

import (
	"github.com/maddalax/htmgo/framework/h"
	"htmgo-site/ui"
)

func Installation(ctx *h.RequestContext) *h.Page {
	return DocPage(
		ctx,
		h.Div(
			h.Class("flex flex-col gap-3"),
			Title("Getting Started"),
			h.Ul(
				h.Text("Prerequisites:"),
				h.Class("list-disc list-inside"),
				h.Li(
					Link("Go 1.2X or above", "https://go.dev/doc/install"),
				),
				h.Li(
					h.Text("Familiarity with "),
					Link("https://htmx.org", "https://htmx.org"),
				),
			),
			HelpText("If you have not read the htmx docs, please do so before continuing, many of the concepts htmgo uses will become clearer."),
			StepTitle("1. Install htmgo"),
			ui.SingleLineBashCodeSnippet(`GOPROXY=direct go install github.com/maddalax/htmgo/cli/htmgo@latest`),
			Text("If you are using Windows, you will need to use the following command instead:"),
			ui.SingleLineBashCodeSnippet(`set GOPROXY=direct && go install github.com/maddalax/htmgo/cli/htmgo@latest`),
			HelpText("Make sure GOPROXY=direct is set, otherwise you may have issues."),
			StepTitle("2. Create new project"),
			ui.SingleLineBashCodeSnippet(`htmgo template`),
			HelpText("this will ask you for a new app name, and it will clone our starter template to a new directory it creates with your app name."),
			StepTitle("3. Running the dev server"),
			ui.SingleLineBashCodeSnippet(`htmgo watch`),
			HelpText("htmgo has built in live reload on the dev server, to use this, run this command in the root of your project"),
			HelpText("If you prefer to run the dev server yourself (no live reload), use `htmgo run`"),
			StepTitle("4. Building for production"),
			ui.SingleLineBashCodeSnippet(`htmgo build`),
			HelpText("it will be output to `./dist`"),
			NextStep(
				"mt-4",
				PrevBlock("Introduction", DocPath("/introduction")),
				NextBlock("Core Concepts", DocPath("/core-concepts/pages")),
			),
		),
	)
}