Skip to content

link checking alone should not change formatting behaviour #178

@bwplotka

Description

@bwplotka

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions