Skip to content

Commit

Permalink
Add local Markdown linting
Browse files Browse the repository at this point in the history
Signed-off-by: Nathan Weinberg <[email protected]>
  • Loading branch information
nathan-weinberg committed Jun 3, 2024
1 parent bb4b452 commit 6e5ad15
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# SPDX-License-Identifier: Apache-2.0

config:
line-length: false
no-emphasis-as-header: false
first-line-heading: false
code-block-style: false
no-duplicate-header: false
single-trailing-newline: false
globs:
- "**/*.md"
ignores:
- ".github/**"
- "venv/**"
- ".venv/**"
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,8 @@ check: ## check git diff between this repo and the CLI generator directory
@echo "=== CHANGES SINCE LAST IMPORT FROM instructlab/instructlab repo:"
@echo "==="
@git diff $(SDG_IMPORT_REF)..origin/main -- src/instructlab/generator/ | cat

.PHONY: md-lint
md-lint: ## Lint markdown files
$(ECHO_PREFIX) printf " %-12s ./...\n" "[MD LINT]"
$(CMD_PREFIX) podman run --rm -v $(CURDIR):/workdir --security-opt label=disable docker.io/davidanson/markdownlint-cli2:latest > /dev/null
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# sdg

Python library for Synthetic Data Generation

0 comments on commit 6e5ad15

Please sign in to comment.