Skip to content

Commit

Permalink
Merge branch 'main' into feat/rust-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenj authored Dec 7, 2023
2 parents eb27ee9 + 9337c73 commit 43bd189
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 49 deletions.
14 changes: 0 additions & 14 deletions .github/workflows/markdown-check.yml

This file was deleted.

14 changes: 0 additions & 14 deletions .github/workflows/spell-check.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .markdownlint.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
},
// MD042/no-empty-links - No empty links
"MD042": true,
// MD043/required-headings/required-headers - Required heading structure
// MD043/required-headings/required-headings - Required heading structure
"MD043": {
// List of headings
"headings": [
Expand Down
10 changes: 5 additions & 5 deletions .vscode/tasks.recommended.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
{
"label": "CI - Recursive Markdown Lint - Check",
"type": "shell",
"command": "earthly -P +markdown-check",
"command": "earthly -P +check-markdown",
"problemMatcher": {
"owner": "markdown-check",
"owner": "check-markdown",
"pattern": {
"regexp": "(\\S+):(\\d+):(\\d+)\\s(.+)",
"file": 1,
Expand All @@ -24,7 +24,7 @@
"type": "shell",
"command": "earthly -P +markdown-check-fix",
"problemMatcher": {
"owner": "markdown-check",
"owner": "markdown-check-fix",
"pattern": {
"regexp": "(\\S+):(\\d+):(\\d+)\\s(.+)",
"file": 1,
Expand All @@ -40,9 +40,9 @@
{
"label": "CI - Recursive Spell Check",
"type": "shell",
"command": "earthly -P +spell-check",
"command": "earthly -P +check-spelling",
"problemMatcher": {
"owner": "spell-check",
"owner": "check-spelling",
"pattern": {
"regexp": "([\\S+]+):(\\d+):(\\d+)\\s-\\s(.+)",
"file": 1,
Expand Down
24 changes: 12 additions & 12 deletions Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@ FROM debian:stable-slim

# cspell: words livedocs sitedocs

markdown-check:
# Check Markdown in this repo.
LOCALLY

DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.9+MDLINT_LOCALLY --src=$(echo ${PWD})
# check-markdown markdown check using catalyst-ci.
check-markdown:
DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.10+CHECK

# markdown-check-fix markdown check and fix using catalyst-ci.
markdown-check-fix:
# Check Markdown in this repo.
LOCALLY

DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.9+MDLINT_LOCALLY --src=$(echo ${PWD}) --fix=--fix
DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.10+MDLINT_LOCALLY --src=$(echo ${PWD}) --fix=--fix

spell-check:
# Check spelling in this repo.
LOCALLY
# check-spelling Check spelling in this repo inside a container.
check-spelling:
DO github.com/input-output-hk/catalyst-ci/earthly/cspell:v2.0.10+CHECK

check:
BUILD +check-spelling
BUILD +check-markdown

DO github.com/input-output-hk/catalyst-ci/earthly/cspell:v2.0.9+CSPELL_LOCALLY --src=$(echo ${PWD})

repo-docs:
# Create artifacts of extra files we embed inside the documentation when its built.
FROM scratch
Expand Down
2 changes: 1 addition & 1 deletion docs/src/appendix/important/coc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ title: Code of Conduct
---

<!-- markdownlint-disable first-line-h1 -->
<!-- markdownlint-disable required-headers -->
<!-- markdownlint-disable required-headings -->
{{ include_file('includes/repo/CODE_OF_CONDUCT.md') }}
2 changes: 1 addition & 1 deletion docs/src/appendix/important/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ icon: material/pen-plus
---

<!-- markdownlint-disable first-line-h1 -->
<!-- markdownlint-disable required-headers -->
<!-- markdownlint-disable required-headings -->
{{ include_file('includes/repo/CONTRIBUTING.md') }}
2 changes: 1 addition & 1 deletion docs/src/appendix/important/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ icon: material/security
---

<!-- markdownlint-disable first-line-h1 -->
<!-- markdownlint-disable required-headers -->
<!-- markdownlint-disable required-headings -->
{{ include_file('includes/repo/SECURITY.md') }}

0 comments on commit 43bd189

Please sign in to comment.