mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-09 13:51:57 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

ci: add workflow to lint documentation

Browse source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2023-07-05 01:39:12 +02:00
parent 5d414ca5a1
commit 366515e760
7 changed files with 148 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

42
docs/.markdownlint.json Normal file
View file

@ -0,0 +1,42 @@
{
"default": true,
"MD002": false,
"MD003": {
"style": "atx"
},
"MD004": {
"style": "dash"
},
"MD009": {
"br_spaces": 2,
"list_item_empty_lines": true,
"strict": false
},
"MD013": {
"code_block_line_length": 100,
"line_length": 100,
"tables": false,
"stern": true
},
"MD029": {
"style": "ordered"
},
"MD035": {
"style": "---"
},
"MD044": {
"names": ["HedgeDoc"]
},
"MD046": {
"style": "fenced"
},
"MD048": {
"style": "backtick"
},
"MD049": {
"style": "asterisk"
},
"MD050": {
"style": "asterisk"
}
}

3
docs/.markdownlint.json.license Normal file
View file

@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
SPDX-License-Identifier: AGPL-3.0-only

13
docs/package.json Normal file
View file

@ -0,0 +1,13 @@
{
"name": "@hedgedoc/docs",
"version": "2.0.0-dev",
"license": "AGPL-3.0",
"scripts": {
"lint": "markdownlint-cli2 content/**/*.md",
"lint:fix": "markdownlint-cli2 --fix content/**/*.md"
},
"devDependencies": {
"markdownlint-cli2": "0.8.1"
},
"packageManager": "yarn@3.6.1"
}

3
docs/package.json.license Normal file
View file

@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
SPDX-License-Identifier: AGPL-3.0-only