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

Jump to bottom

Add linting to CI for martin book #1030

Merged
merged 38 commits into from
Dec 4, 2023
Merged

Add linting to CI for martin book #1030

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
45f7fc8
Add markdown lint action
sharkAndshark Nov 29, 2023
b0c1ff1
Add custom markdown config file
sharkAndshark Nov 29, 2023
6eb61f5
Update globs expressions
sharkAndshark Nov 29, 2023
f2f8d15
Ignore the linting of `CHANGELOG.md`
sharkAndshark Nov 29, 2023
f9e9125
Update
sharkAndshark Nov 29, 2023
a1cd714
Eliminate `MD022/blanks-around-headings` warnings
sharkAndshark Nov 29, 2023
da85d68
Eliminate `MD022/blanks-around-headings` warnings
sharkAndshark Nov 29, 2023
445cc21
Eliminate `MD022/blanks-around-headings` warnings
sharkAndshark Nov 29, 2023
d75a162
Run `markdownlint-cli2 --fix`
sharkAndshark Nov 29, 2023
688c9d6
Ignore MD013 rule
sharkAndshark Nov 30, 2023
db70bf1
Ignore MD041, MD033
sharkAndshark Dec 1, 2023
316169c
Add relative link check
sharkAndshark Dec 1, 2023
aca15c3
Use markdown-link-check github action
sharkAndshark Dec 1, 2023
407e642
Set link check path
sharkAndshark Dec 1, 2023
58b335a
Ignore localhost
sharkAndshark Dec 1, 2023
a728eaf
fix link in run-with-nginx.md
sharkAndshark Dec 1, 2023
20a33d8
Add httpheader and timeout
sharkAndshark Dec 1, 2023
072c5cb
Update link check config
sharkAndshark Dec 1, 2023
e136541
Add headers for opensource.org
sharkAndshark Dec 1, 2023
63f7188
Update license link
sharkAndshark Dec 1, 2023
87da4c7
Update headers for opensource.org
sharkAndshark Dec 1, 2023
88b4548
Rename markdown lint config file
sharkAndshark Dec 1, 2023
02b3bf7
Add markdown fmt to jsut fmt
sharkAndshark Dec 1, 2023
eeae4b0
Add link check to just clippy
sharkAndshark Dec 1, 2023
911aa38
Remove img.shields.io from ignore list
sharkAndshark Dec 2, 2023
b0ec469
Add --fix to just fmt
sharkAndshark Dec 2, 2023
d0d0da5
Ignore opensource.org
sharkAndshark Dec 2, 2023
74d9b63
Ignore MD045 MD001 in markdown lintting
sharkAndshark Dec 2, 2023
6c9c102
Merge remote-tracking branch 'remote/main' into doc_style_check
sharkAndshark Dec 2, 2023
186155e
Update martin-cp.md
sharkAndshark Dec 2, 2023
c0f9987
Remove opensource.org from httpheaders
sharkAndshark Dec 4, 2023
aae73ea
Remove NPM packages
sharkAndshark Dec 4, 2023
307f60d
Add fmt-md to justfile
sharkAndshark Dec 4, 2023
f700492
Move link check to just clippy-md
sharkAndshark Dec 4, 2023
cd0847a
Update link checking headers
sharkAndshark Dec 4, 2023
fdac18e
optimize link check
nyurik Dec 4, 2023
8c03249
minor doc
nyurik Dec 4, 2023
3117989
cleanup justfile
nyurik Dec 4, 2023
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
12 changes: 12 additions & 0 deletions .github/files/.markdownlint.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"config": {
"default": true,
"relative-links": true
},
// globs expression. See https://github.com/DavidAnson/markdownlint-cli2#command-line
"globs": [
"**/*.md",
"#CHANGELOG.md"
sharkAndshark marked this conversation as resolved.
Show resolved Hide resolved
],
"customRules": ["markdownlint-rule-relative-links"]
}
5 changes: 5 additions & 0 deletions .github/workflows/build-deploy-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ jobs:
- uses: actions/checkout@v4
- uses: Swatinem/rust-cache@v2

- name: Markdown lint
uses: DavidAnson/markdownlint-cli2-action@v14
with:
config: './.github/files/.markdownlint.jsonc'

- name: Setup mdBook
uses: peaceiris/actions-mdbook@v1
with:
Expand Down
Loading