47 lines
1.1 KiB
Makefile
47 lines
1.1 KiB
Makefile
# Building docs makefile defined.
|
|
#
|
|
# All make targets related to docs are defined in this file.
|
|
|
|
DOCS_OUTPUT_DIR := site/public
|
|
|
|
##@ Docs
|
|
|
|
.PHONY: docs
|
|
docs: docs.clean
|
|
@$(LOG_TARGET)
|
|
cd $(ROOT_DIR)/docs/site && npm install
|
|
cd $(ROOT_DIR)/docs/site && npm run build:production
|
|
|
|
.PHONY: check-links
|
|
check-links: ## Check for broken links in the docs.
|
|
check-links: docs-check-links
|
|
|
|
|
|
.PHONY: docs-check-links
|
|
docs-check-links:
|
|
@$(LOG_TARGET)
|
|
# Check for broken links
|
|
npm install -g linkinator@6.0.4
|
|
# https://github.com/JustinBeckwith/linkinator?tab=readme-ov-file#command-usage
|
|
linkinator docs/site/public -r --concurrency 25 -s "github.com _print v0.0.1"
|
|
|
|
# Docs site, make by hexo.
|
|
|
|
.PHONY: docs-serve
|
|
docs-serve: ## Start API Testing Site Locally.
|
|
@$(LOG_TARGET)
|
|
cd $(ROOT_DIR)/docs/site && npm run serve
|
|
|
|
.PHONY: docs-clean
|
|
docs-clean: ## Remove all files that are created during builds.
|
|
docs-clean: docs.clean
|
|
|
|
.PHONY: docs.clean
|
|
docs.clean:
|
|
@$(LOG_TARGET)
|
|
rm -rf $(DOCS_OUTPUT_DIR)
|
|
rm -rf docs/site/node_modules
|
|
rm -rf docs/site/resources
|
|
rm -f docs/site/package-lock.json
|
|
rm -f docs/site/.hugo_build.lock
|