mdox icon indicating copy to clipboard operation
mdox copied to clipboard

link checking alone should not change formatting behaviour

Open bwplotka opened this issue 5 months ago • 0 comments

It's confusing but this kind of use will not work

.PHONY: fmt
fmt: ## Format docs, ensure GitHub format.
fmt: $(MDOX)
	@echo "Formatting markdown files..."
	$(MDOX) fmt --soft-wraps  $(MD_FILES_TO_FORMAT)

.PHONY: check
check: ## Checks if doc is formatter and links are correct (don't check external links).
check: $(MDOX)
	@echo "Checking markdown file formatting and basic links."
	$(MDOX) fmt --soft-wraps --links.validate --links.validate.config-file=.github/.mdox.validator.yaml --check $(MD_FILES_TO_FORMAT)

This is because somehow adding --links.validate changes formatting, so $(MDOX) fmt --soft-wraps $(MD_FILES_TO_FORMAT) and $(MDOX) fmt --links.validate --soft-wraps $(MD_FILES_TO_FORMAT) will do different things.

Fix for consistency.

bwplotka avatar Sep 09 '25 08:09 bwplotka