Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] docs: Disable Go reformatting #961

Closed
wants to merge 3 commits into from
Closed

[WIP] docs: Disable Go reformatting #961

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e75f33c
[do not land] tools/go.mod: Pin to mdox fork
abhinav Oct 11, 2022
98026db
docs(mdox): Disable go reformatting
abhinav Oct 11, 2022
35eb038
docs: make fmt
abhinav Oct 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(mdox): Disable go reformatting 
Disable reformatting of Go code by mdox because it produces wildly
inconsistent output.
  • Loading branch information
@abhinav
abhinav committed Oct 13, 2022
commit 98026dbea8642c25c5310b4647d0c9325e44c0f8
6 changes: 5 additions & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
export PATH := $(shell pwd)/bin:$(PATH)

MDOX = $(shell pwd)/../bin/mdox
MDOX_FMT_FLAGS = --soft-wraps --links.validate --links.validate.config-file $(shell pwd)/.mdox-validate.yaml
MD_FILES ?= $(shell git ls-files '*.md')
MDOX_FMT_FLAGS = \
--soft-wraps \
--no-gofmt \
--links.validate \
--links.validate.config-file $(shell pwd)/.mdox-validate.yaml

.PHONY:
fmt: $(MDOX)
Expand Down