Skip to content

Commit

Permalink
Improve linting
Browse files Browse the repository at this point in the history
  • Loading branch information
maxammann committed Feb 8, 2024
1 parent db1df8d commit 0af1ed2
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 7 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/markdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@ jobs:
- uses: actions/checkout@v3
- uses: DavidAnson/markdownlint-cli2-action@v9
with:
command: config
globs: |
.github/workflows/.markdownlint.jsonc
**/*.md
globs: "**/*.md"
# Spellcheck Markdown files using `retext` and `remark`
# Uses: a custom dictionary file
spellcheck:
Expand Down
3 changes: 3 additions & 0 deletions .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"ignores": ["content/docs/fuzzing/**", "themes/book/**", "node_modules/**"]
}
File renamed without changes.
1 change: 0 additions & 1 deletion .markdownlintignore

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Your browser will be automatically refreshed with changes whenever you save a fi
6. Edit, add, and create pull requests to merge your changes into `main`.
7. ❗Keep in mind that when you merge your PR into `main`, the content goes live in https://appsec.guide.
7. ❗Keep in mind that when you merge your PR into `main`, the content goes live in <https://appsec.guide>.
Our current policy forces at least one review before merging.
8. For updates to the home page, edit [content/_index.md](content/_index.md)
Expand Down Expand Up @@ -136,7 +136,7 @@ This addon works better than pandoc.
5. Open the copy and run the Addon.
6. Export the markdown and apply fixes:
- Search for occurences of `<code>` or `<strong>` or any other html tags
- Replace HTML tables with markdown ones (https://jmalarcon.github.io/markdowntables/)
- Replace HTML tables with markdown ones (<https://jmalarcon.github.io/markdowntables/>)
- If you split your document, fix internal links.
- Add missing images.
- Fix `&lt;`, …, “, ’
Expand Down

0 comments on commit 0af1ed2

Please sign in to comment.