Files
releases/docs/Makefile
Charlie Egan b29b1dad76 docs/website: Markdown linting and spell checking for documentation (#8292)
* Add markdownlint tooling to docs

Install markdownlint-cli2 with configuration file and make targets for
auto fix etc too.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* Autofixable markdown issues

mainly, replace tabs with spaces for consistent 2-space indentation

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* MD059

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* Fix a number of <link> issues

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* MD041

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* MD041

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* MD046

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* MD025

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* MD052

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* MD028

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* MD001

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* Add GH action check in PRs

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* Use 4 spaces for tabs

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* Use 4 spaces for tabs

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* docs: Add spell checking using Vale

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* Correct comment for space indentation rule

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

---------

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2026-02-05 10:20:13 +00:00

63 lines
950 B
Makefile

.PHONY: install
install:
npm install
.PHONY: ci
ci:
npm ci
.PHONY: dev
dev:
# --no-open means that the browser will not be opened on start.
# This is done to avoid opening many tabs repeatedly when editing
# docusaurus.config.js.
npx docusaurus start --no-open
.PHONY: build
build:
npx docusaurus build
.PHONY: build-latest
build-latest:
./bin/build-latest.sh
.PHONY: clean
clean:
rm -rf build .docusaurus
.PHONY: generate-cli-docs
generate-cli-docs:
$(CURDIR)/../build/gen-cli-docs.sh > $(CURDIR)/src/data/cli.json
.PHONY: smoke-test
smoke-test:
./bin/smoke-test.sh
.PHONY: fmt
fmt:
npx dprint fmt
.PHONY: fmt-check
fmt-check:
npx dprint check
.PHONY: lint
lint:
npx eslint --fix .
.PHONY: lint-check
lint-check:
npx eslint .
.PHONY: markdownlint
markdownlint:
npx markdownlint-cli2 --fix
.PHONY: markdownlint-check
markdownlint-check:
npx markdownlint-cli2
.PHONY: spell-check
spell-check:
vale --config=.vale.ini .