forgejo/docs/Makefile

THEME := themes/gitea
PUBLIC := public
ARCHIVE := https://dl.gitea.com/theme/main.tar.gz

HUGO_PACKAGE := github.com/gohugoio/hugo@v0.111.3

.PHONY: all
all: build

.PHONY: clean
clean:
	rm -rf $(PUBLIC) $(THEME)

.PHONY: trans-copy
trans-copy:
	bash scripts/trans-copy.sh

.PHONY: server
server: $(THEME)
	go run $(HUGO_PACKAGE) server

.PHONY: build
build: $(THEME)
	go run $(HUGO_PACKAGE) --cleanDestinationDir

.PHONY: build-offline
build-offline: $(THEME)
	go run $(HUGO_PACKAGE) --baseURL="/" --cleanDestinationDir

.PHONY: update
update: $(THEME)

$(THEME): $(THEME)/theme.toml
$(THEME)/theme.toml:
	mkdir -p $$(dirname $@)
	curl -L -s $(ARCHIVE) | tar xz -C $$(dirname $@)
Import docs into main repository (#2874) * import docs into main repository Signed-off-by: Matti Ranta <matti@mdranta.net> 2017-11-27 00:44:32 +03:00			`THEME := themes/gitea`
			`PUBLIC := public`
Update path to docs theme file (#23502) The branch name for the theme was updated to main 2023-03-15 23:59:29 +03:00			`ARCHIVE := https://dl.gitea.com/theme/main.tar.gz`
Import docs into main repository (#2874) * import docs into main repository Signed-off-by: Matti Ranta <matti@mdranta.net> 2017-11-27 00:44:32 +03:00
Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) - Installation: includes how to install Gitea and related other tools, also includes upgrade Gitea - Administration: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - Usage: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - Development: includes how to integrate with Gitea's API, how to develop new features within Gitea - Contributing: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com> 2023-03-23 18:18:24 +03:00			`HUGO_PACKAGE := github.com/gohugoio/hugo@v0.111.3`
Run hugo via `go run` and lock its version (#22206) - Don't rely on obscure docker images like `plugins/hugo` - Lock down `hugo` to same version the image had used - Remove unnecessary verbosity in `trans-copy` - Rename `trans-copy` to `trans-copy.sh` Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: John Olheiser <john+github@jolheiser.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io> 2022-12-22 05:09:53 +03:00
Import docs into main repository (#2874) * import docs into main repository Signed-off-by: Matti Ranta <matti@mdranta.net> 2017-11-27 00:44:32 +03:00			`.PHONY: all`
			`all: build`

			`.PHONY: clean`
			`clean:`
			`rm -rf $(PUBLIC) $(THEME)`

			`.PHONY: trans-copy`
			`trans-copy:`
Run hugo via `go run` and lock its version (#22206) - Don't rely on obscure docker images like `plugins/hugo` - Lock down `hugo` to same version the image had used - Remove unnecessary verbosity in `trans-copy` - Rename `trans-copy` to `trans-copy.sh` Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: John Olheiser <john+github@jolheiser.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io> 2022-12-22 05:09:53 +03:00			`bash scripts/trans-copy.sh`
Import docs into main repository (#2874) * import docs into main repository Signed-off-by: Matti Ranta <matti@mdranta.net> 2017-11-27 00:44:32 +03:00
			`.PHONY: server`
			`server: $(THEME)`
Run hugo via `go run` and lock its version (#22206) - Don't rely on obscure docker images like `plugins/hugo` - Lock down `hugo` to same version the image had used - Remove unnecessary verbosity in `trans-copy` - Rename `trans-copy` to `trans-copy.sh` Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: John Olheiser <john+github@jolheiser.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io> 2022-12-22 05:09:53 +03:00			`go run $(HUGO_PACKAGE) server`
Import docs into main repository (#2874) * import docs into main repository Signed-off-by: Matti Ranta <matti@mdranta.net> 2017-11-27 00:44:32 +03:00
			`.PHONY: build`
			`build: $(THEME)`
Run hugo via `go run` and lock its version (#22206) - Don't rely on obscure docker images like `plugins/hugo` - Lock down `hugo` to same version the image had used - Remove unnecessary verbosity in `trans-copy` - Rename `trans-copy` to `trans-copy.sh` Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: John Olheiser <john+github@jolheiser.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io> 2022-12-22 05:09:53 +03:00			`go run $(HUGO_PACKAGE) --cleanDestinationDir`
Import docs into main repository (#2874) * import docs into main repository Signed-off-by: Matti Ranta <matti@mdranta.net> 2017-11-27 00:44:32 +03:00
release docs as an archive (#12243) * release docs along sources * use a custom offline version Co-authored-by: Gitea <gitea@fake.local> 2020-07-14 05:09:39 +03:00			`.PHONY: build-offline`
			`build-offline: $(THEME)`
Run hugo via `go run` and lock its version (#22206) - Don't rely on obscure docker images like `plugins/hugo` - Lock down `hugo` to same version the image had used - Remove unnecessary verbosity in `trans-copy` - Rename `trans-copy` to `trans-copy.sh` Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: John Olheiser <john+github@jolheiser.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io> 2022-12-22 05:09:53 +03:00			`go run $(HUGO_PACKAGE) --baseURL="/" --cleanDestinationDir`
release docs as an archive (#12243) * release docs along sources * use a custom offline version Co-authored-by: Gitea <gitea@fake.local> 2020-07-14 05:09:39 +03:00
Import docs into main repository (#2874) * import docs into main repository Signed-off-by: Matti Ranta <matti@mdranta.net> 2017-11-27 00:44:32 +03:00			`.PHONY: update`
			`update: $(THEME)`

Ensure docs makefile downloads theme if failed before. (#3322) The makefile did not download the theme if the directory "themes/gitea" is there, even if empty. On a fresh Ubuntu install, curl is not included, so the theme rule fails just after creating the empty directory. When you try again after installing curl, the rule is not triggered. This could also happen if the download fails for other reasons. This change makes the theme rule depend on the file "theme.toml" which will be there only after unpacking a successfully downloaded theme archive. Signed-off-by: Alberto González Palomo <bugs@sentido-labs.com> 2018-01-07 15:11:17 +03:00			`$(THEME): $(THEME)/theme.toml`
			`$(THEME)/theme.toml:`
			`mkdir -p $$(dirname $@)`
follow redirect when fetching theme archive (#15986) 2021-05-27 01:03:39 +03:00			`curl -L -s $(ARCHIVE) \| tar xz -C $$(dirname $@)`