go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-11-28 07:21:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
fe99b9fb1e
elvish/website/Makefile

52 lines
1.4 KiB
Makefile
Raw Normal View History

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
# Generates the website into $(DST_DIR).
website: Make the tool dependency for %.html more accurate. Only depend on the tools referenced by tools/md-to-html. This uses "grep -o", which is not part of POSIX but is supported by both GNU and BSD greps, so widely enough.
2022-01-01 23:26:01 +08:00
gen: tools/gensite.bin $(HTMLS)
website: Rename the "genblog" tool to "gensite". Also rename internal references to the "blog" to "site" when it refers to the site as the whole (instead of https://elv.sh/blog).
2022-01-01 20:06:27 +08:00
tools/gensite.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).
website: Make the tool dependency for %.html more accurate. Only depend on the tools referenced by tools/md-to-html. This uses "grep -o", which is not part of POSIX but is supported by both GNU and BSD greps, so widely enough.
2022-01-01 23:26:01 +08:00
docset: tools/gensite.bin $(HTMLS)
website: Rename the "genblog" tool to "gensite". Also rename internal references to the "blog" to "site" when it refers to the site as the whole (instead of https://elv.sh/blog).
2022-01-01 20:06:27 +08:00
ELVISH_DOCSET_MODE=1 tools/gensite.bin . $(DOCSET_TMP_DIR)
website: Make the tool dependency for %.html more accurate. Only depend on the tools referenced by tools/md-to-html. This uses "grep -o", which is not part of POSIX but is supported by both GNU and BSD greps, so widely enough.
2022-01-01 23:26:01 +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: Make the tool dependency for %.html more accurate. Only depend on the tools referenced by tools/md-to-html. This uses "grep -o", which is not part of POSIX but is supported by both GNU and BSD greps, so widely enough.
2022-01-01 23:26:01 +08:00
rm -rf tools/*.bin $(HTMLS) $(DST_DIR) $(DOCSET_TMP_DIR) $(DOCSET_DST_DIR)
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
website: Move ttyshots to be side by side with markdown files. Also rewrite the documentation.
2022-08-05 06:38:08 +08:00
ifdef TTYSHOT
Use .elvts as the standard extension of Elvish transcripts. Rename the existing ttyshot instruction files to use the new extension too.
2023-03-02 06:39:06 +08:00
%.ttyshot.html: %.elvts tools/ttyshot.bin
website: Make ttyshots look like transcripts. This further simplifies the op structure - only code input and tmux commands are necessary now; waiting for prompts is now implicit.
2022-08-09 20:43:21 +08:00
tools/ttyshot.bin $(if $(findstring verbose,$(TTYSHOT)),-v,) -o $@ $<
website: Move ttyshots to be side by side with markdown files. Also rewrite the documentation.
2022-08-05 06:38:08 +08:00
else
%.ttyshot.html:
@: ttyshot generation disabled by default
endif
website/Makefile: add @ttyshot dependencies. Also rename the ref-deps script to extra-deps now that its scope is a bit larger.
2021-12-28 21:13:27 +08:00
website: Make the tool dependency for %.html more accurate. Only depend on the tools referenced by tools/md-to-html. This uses "grep -o", which is not part of POSIX but is supported by both GNU and BSD greps, so widely enough.
2022-01-01 23:26:01 +08:00
.PHONY: gen docset publish check-rellinks 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
website/Makefile: Prevent removal of intermediate targets.
2022-01-04 01:54:06 +08:00
# Don't remove intermediate targets
.SECONDARY:
website/cmd/md2html: Reduce dependency on Elvish packages. This command used to depend on pkg/mods/doc to access the embedded .elv, which in turn depends on all the packages that implement builtin modules. The latter set of packages depends on almost all the Elvish packages transitively. As a result, almost any change in any Elvish package will trigger a rebuild of this command and the whole website. This commit minimizes the dependency on Elvish packages by having it read the .elv files during runtime instead (enabled by 9112eb1ab2f45dce98ed87e19b619319348c900d). Additionally: - Move HighlightCodeBlock, needed by website/cmd/md2html, from pkg/mods/doc to pkg/elvdoc. Moving it is necessary to completely remove the dependency of website/cmd/md2html on pkg/mods/doc. - Remove the dependency of pkg/edit/highlight on pkg/eval. It only uses eval.UnpackCompilationErrors; move this work to the supplied Check function. This removes the transitive dependency of website/cmd/md2html on pkg/eval. - Augment website/tools/md-deps to recognize @module lines and add dependency on the corresponding .elv files.
2024-01-09 07:30:15 +08:00
# Rules below have dynamic prerequisite lists, which requires GNU Make's
# .SECONDEXPANSION.
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
.SECONDEXPANSION:
website/Makefile: rewrite dependency logic. Since .d.elv files are now accessed via Go files that embed them, cmd/md2html needs to be rebuilt whenever one of its dependencies changes.
2023-01-02 02:09:58 +08:00
tools/%.bin: cmd/% $$(wildcard cmd/%/*) go.mod ../go.mod $$(shell tools/cmd-deps ./cmd/%)
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
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/Makefile: rewrite dependency logic. Since .d.elv files are now accessed via Go files that embed them, cmd/md2html needs to be rebuilt whenever one of its dependencies changes.
2023-01-02 02:09:58 +08:00
%.html: %.md tools/md2html.bin $$(shell tools/md-deps $$@)
website: Integrate cmd/macros into cmd/md2html.
2023-01-02 01:53:23 +08:00
tools/md2html.bin < $< > $@
Reference in New Issue Copy Permalink