chore(repo/management): markdownlint

This commit is contained in:
Michele Cereda
2024-03-18 18:19:15 +01:00
parent 89a8463a03
commit 0cd334ff03
5 changed files with 50 additions and 8 deletions

View File

@@ -15,6 +15,11 @@ lint:
# just use the local command.
glob: "*Dockerfile*"
run: hadolint {all_files}
md: &markdownlint
glob: "*.md"
run: >- # '{all_files}' and {files} only include ones managed by git for some reason
docker run --rm -v "$PWD:/workdir" 'ghcr.io/igorshubovych/markdownlint-cli:latest'
**.md
yaml: &yamllint
glob: "*.{yaml,yml}"
run: >-
@@ -53,6 +58,11 @@ pre-commit:
lint-docker:
<<: *hadolint
run: hadolint {staged_files}
lint-md:
<<: *markdownlint
run: >-
docker run --rm -v "$PWD:/workdir" 'ghcr.io/igorshubovych/markdownlint-cli:latest'
{staged_files}
lint-yaml:
<<: *yamllint
run: >-

View File

@@ -1,4 +0,0 @@
{
"MD013": false,
"MD033": false
}

7
.markdownlint.yaml Normal file
View File

@@ -0,0 +1,7 @@
---
# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
default: true
MD013:
line_length: 120
MD033: false

33
.vscode/settings.json vendored
View File

@@ -1,12 +1,39 @@
{
"editor.formatOnPaste": true,
"json.schemas": [
{
"fileMatch": [
".lefthook.yaml",
".lefthook.yml"
],
"url": "https: //json.schemastore.org/lefthook.json"
},
{
"fileMatch": [
".markdownlint.js",
".markdownlint.json",
".markdownlint.jsonc",
".markdownlint.yaml"
],
"url": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json"
},
{
"fileMatch": [ ".pre-commit-config.yaml" ],
"url": "https://json.schemastore.org/pre-commit-config.json"
},
{
"fileMatch": [ "package.json" ],
"url": "https://json.schemastore.org/package.json"
},
{
"fileMatch": [ "Pulumi.yaml" ],
"url": "https://json.schemastore.org/pulumi.json"
}
],
"markdown.extension.toc.levels": "2..6",
"markdown.extension.toc.orderedList": true,
"cSpell.language": "en,en-GB",
"cSpell.words": [
"adduser",
@@ -57,6 +84,7 @@
"eeprom",
"epel",
"fallocate",
"fargate",
"fastboot",
"fdupes",
"firewalld",
@@ -90,6 +118,7 @@
"keygrip",
"kivi",
"knockd",
"kubeconfig",
"kubectx",
"kubelet",
"kubens",
@@ -177,7 +206,5 @@
"xattr",
"xkcd",
"zstd"
],
"markdown.extension.toc.levels": "2..6",
"markdown.extension.toc.orderedList": true
]
}

View File

@@ -1,6 +1,8 @@
# OAM
A.K.A. _Operations, administration and management_ or _operations, administration and maintenance_, the processes, activities, tools, and standards involved with operating, administering, managing and maintaining any system. This commonly applies to telecommunication, computer networks, and computer hardware.
A.K.A. _Operations, administration and management_ or _operations, administration and maintenance_, the processes,
activities, tools, and standards involved with operating, administering, managing and maintaining any system.<br/>.
This commonly applies to telecommunication, computer networks, and computer hardware.
In short, my private collection of notes and scripts. I use them to ease my tech life.