elvish/website/Makefile

DST_DIR := ./_dst
PUBLISH_DIR := ./_publish
DOCSET_TMP_DIR := ./_docset_tmp
DOCSET_DST_DIR := ./Elvish.docset

MDS := home.md $(filter-out %/README.md,$(wildcard [^_]*/*.md))
HTMLS := $(MDS:.md=.html)

TOOL_PKGS := highlight macros elvdoc genblog
TOOL_BINS := $(addprefix tools/,$(addsuffix .bin,$(TOOL_PKGS)))

# Generates the website into $(DST_DIR).
gen: $(TOOL_BINS) $(HTMLS)
	tools/genblog.bin . $(DST_DIR)
	ln -sf `pwd`/fonts `pwd`/favicons/* $(DST_DIR)/

# Generates docset into $(DOCSET_DST_DIR).
docset: $(TOOL_BINS) $(HTMLS)
	ELVISH_DOCSET_MODE=1 tools/genblog.bin . $(DOCSET_TMP_DIR)
	./tools/mkdocset $(DOCSET_TMP_DIR) $(DOCSET_DST_DIR)

# Synchronizes the generated website into $(PUBLISH_DIR), which is passed to
# rsync and can be a remote place.
publish: gen
	rsync -aLv --delete ./_dst/ $(PUBLISH_DIR)/

check-rellinks: gen
	python3 tools/check-rellinks.py $(DST_DIR)

clean:
	rm -rf $(TOOL_BINS) $(HTMLS) $(DST_DIR) $(DOCSET_TMP_DIR) $(DOCSET_DST_DIR)

.PHONY: gen docset publish clean

.SECONDEXPANSION:

tools/%.bin: cmd/% $$(wildcard cmd/%/*.go)
	go build -o $@ ./$<

%.html: %.md $(TOOL_BINS) tools/md-to-html $$(shell tools/ref-deps $$@)
	tools/md-to-html $< $@
Remove navbar and hide ToC in docset files. This is implemented by using an environment variable ELVISH_DOCSET_MODE to control the template. 2021-06-13 08:46:27 +08:00			`DST_DIR := ./_dst`
website: Reorganize. Every subdirectory other than src/ now has a _ prefix. The content of src/ is moved into the root of website directory itself. 2018-08-28 03:57:51 +08:00			`PUBLISH_DIR := ./_publish`
Remove navbar and hide ToC in docset files. This is implemented by using an environment variable ELVISH_DOCSET_MODE to control the template. 2021-06-13 08:46:27 +08:00			`DOCSET_TMP_DIR := ./_docset_tmp`
			`DOCSET_DST_DIR := ./Elvish.docset`
website: Attempt to fix Makefile for GNU Make >= 4. GNU Make >= 4 seems to behave differently with regards to dependencies with slashes in them. In particular, the dependency on tools/* in the wildcard rule %.html: %.md tools/... does not seem to cause tools/... to be built correctly. Working around this by putting all tools in the root directory, with binaries ending in ".tool". 2018-06-13 05:58:16 +08:00
website: Restructure directory. * Remove the _ prefix from directories. * Move cmd/website -> website/cmd. 2020-06-14 20:56:58 +08:00			`MDS := home.md $(filter-out %/README.md,$(wildcard [^_]/.md))`
Move source code for the website into this repo. The website contains documentations. Merging these two repos makes them more discoverable, and encourages updating the code and doc at the same time. 2018-06-06 04:33:59 +08:00			`HTMLS := $(MDS:.md=.html)`
website: Attempt to fix Makefile for GNU Make >= 4. GNU Make >= 4 seems to behave differently with regards to dependencies with slashes in them. In particular, the dependency on tools/* in the wildcard rule %.html: %.md tools/... does not seem to cause tools/... to be built correctly. Working around this by putting all tools in the root directory, with binaries ending in ".tool". 2018-06-13 05:58:16 +08:00
website: Rewrite Makefile. * Reorder the targets to be top-down * Make the tool binaries individual real targets, rather than a phony target * Use .SECONDEXPANSION to determine dependencies of tool binaries and HTML outputs precisely 2021-11-29 22:08:05 +08:00			`TOOL_PKGS := highlight macros elvdoc genblog`
			`TOOL_BINS := $(addprefix tools/,$(addsuffix .bin,$(TOOL_PKGS)))`
Move source code for the website into this repo. The website contains documentations. Merging these two repos makes them more discoverable, and encourages updating the code and doc at the same time. 2018-06-06 04:33:59 +08:00
website: Rewrite Makefile. * Reorder the targets to be top-down * Make the tool binaries individual real targets, rather than a phony target * Use .SECONDEXPANSION to determine dependencies of tool binaries and HTML outputs precisely 2021-11-29 22:08:05 +08:00			`# Generates the website into $(DST_DIR).`
			`gen: $(TOOL_BINS) $(HTMLS)`
			`tools/genblog.bin . $(DST_DIR)`
website: Serve fonts as individual files. Upsides: - Removing the render-blocking fonts.css allows the page to be visible while the font is being loaded. - The original WOFF2 files are smaller than the base64-encoded version in fonts.css. - Browsers may be smart enough to not download fonts that are not needed. The only downside is that this requires the browser to make more requests - up to 6 for all 6 font files. But this is not a problem with modern browsers. 2021-11-11 07:43:44 +08:00			ln -sf `pwd`/fonts `pwd`/favicons/* $(DST_DIR)/
Move source code for the website into this repo. The website contains documentations. Merging these two repos makes them more discoverable, and encourages updating the code and doc at the same time. 2018-06-06 04:33:59 +08:00
website: Rewrite Makefile. * Reorder the targets to be top-down * Make the tool binaries individual real targets, rather than a phony target * Use .SECONDEXPANSION to determine dependencies of tool binaries and HTML outputs precisely 2021-11-29 22:08:05 +08:00			`# Generates docset into $(DOCSET_DST_DIR).`
			`docset: $(TOOL_BINS) $(HTMLS)`
			`ELVISH_DOCSET_MODE=1 tools/genblog.bin . $(DOCSET_TMP_DIR)`
Convert mkdocset to POSIX sh script. 2021-06-15 06:18:22 +08:00			`./tools/mkdocset $(DOCSET_TMP_DIR) $(DOCSET_DST_DIR)`
Remove navbar and hide ToC in docset files. This is implemented by using an environment variable ELVISH_DOCSET_MODE to control the template. 2021-06-13 08:46:27 +08:00
website: Rewrite Makefile. * Reorder the targets to be top-down * Make the tool binaries individual real targets, rather than a phony target * Use .SECONDEXPANSION to determine dependencies of tool binaries and HTML outputs precisely 2021-11-29 22:08:05 +08:00			`# Synchronizes the generated website into $(PUBLISH_DIR), which is passed to`
			`# rsync and can be a remote place.`
Move source code for the website into this repo. The website contains documentations. Merging these two repos makes them more discoverable, and encourages updating the code and doc at the same time. 2018-06-06 04:33:59 +08:00			`publish: gen`
website: Reorganize. Every subdirectory other than src/ now has a _ prefix. The content of src/ is moved into the root of website directory itself. 2018-08-28 03:57:51 +08:00			`rsync -aLv --delete ./_dst/ $(PUBLISH_DIR)/`
Move source code for the website into this repo. The website contains documentations. Merging these two repos makes them more discoverable, and encourages updating the code and doc at the same time. 2018-06-06 04:33:59 +08:00
website: Add Python script to check relative links. 2021-11-30 03:21:51 +08:00			`check-rellinks: gen`
			`python3 tools/check-rellinks.py $(DST_DIR)`

Move source code for the website into this repo. The website contains documentations. Merging these two repos makes them more discoverable, and encourages updating the code and doc at the same time. 2018-06-06 04:33:59 +08:00			`clean:`
website: Rewrite Makefile. * Reorder the targets to be top-down * Make the tool binaries individual real targets, rather than a phony target * Use .SECONDEXPANSION to determine dependencies of tool binaries and HTML outputs precisely 2021-11-29 22:08:05 +08:00			`rm -rf $(TOOL_BINS) $(HTMLS) $(DST_DIR) $(DOCSET_TMP_DIR) $(DOCSET_DST_DIR)`

			`.PHONY: gen docset publish clean`

			`.SECONDEXPANSION:`

			`tools/%.bin: cmd/% $$(wildcard cmd/%/*.go)`
			`go build -o $@ ./$<`
Move source code for the website into this repo. The website contains documentations. Merging these two repos makes them more discoverable, and encourages updating the code and doc at the same time. 2018-06-06 04:33:59 +08:00
website: Rewrite Makefile. * Reorder the targets to be top-down * Make the tool binaries individual real targets, rather than a phony target * Use .SECONDEXPANSION to determine dependencies of tool binaries and HTML outputs precisely 2021-11-29 22:08:05 +08:00			`%.html: %.md $(TOOL_BINS) tools/md-to-html $$(shell tools/ref-deps $$@)`
			`tools/md-to-html $< $@`