diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json new file mode 100644 index 000000000..8b7578c19 --- /dev/null +++ b/docs/.markdownlint.json @@ -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" + } +} \ No newline at end of file diff --git a/docs/.markdownlint.json.license b/docs/.markdownlint.json.license new file mode 100644 index 000000000..991e477fe --- /dev/null +++ b/docs/.markdownlint.json.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file) + +SPDX-License-Identifier: AGPL-3.0-only diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 000000000..c93a5fe24 --- /dev/null +++ b/docs/package.json @@ -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" +} diff --git a/docs/package.json.license b/docs/package.json.license new file mode 100644 index 000000000..991e477fe --- /dev/null +++ b/docs/package.json.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file) + +SPDX-License-Identifier: AGPL-3.0-only diff --git a/package.json b/package.json index a7aee91f5..929d45057 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,8 @@ "backend", "frontend", "commons", - "dev-reverse-proxy" + "dev-reverse-proxy", + "docs" ], "scripts": { "build": "dotenv -- turbo run build", diff --git a/turbo.json b/turbo.json index c7b97f8f6..5e62ebae1 100644 --- a/turbo.json +++ b/turbo.json @@ -53,6 +53,11 @@ "^build" ] }, + "lint:fix": { + "dependsOn": [ + "^build" + ] + }, "format": {}, diff --git a/yarn.lock b/yarn.lock index ba5d331c9..3036b0b6b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2441,6 +2441,14 @@ __metadata: languageName: unknown linkType: soft +"@hedgedoc/docs@workspace:docs": + version: 0.0.0-use.local + resolution: "@hedgedoc/docs@workspace:docs" + dependencies: + markdownlint-cli2: 0.8.1 + languageName: unknown + linkType: soft + "@hedgedoc/frontend@workspace:frontend": version: 0.0.0-use.local resolution: "@hedgedoc/frontend@workspace:frontend" @@ -10711,6 +10719,19 @@ __metadata: languageName: node linkType: hard +"globby@npm:13.1.4": + version: 13.1.4 + resolution: "globby@npm:13.1.4" + dependencies: + dir-glob: ^3.0.1 + fast-glob: ^3.2.11 + ignore: ^5.2.0 + merge2: ^1.4.1 + slash: ^4.0.0 + checksum: e8bc13879972082d590cd1b0e27080d90d2e12fff7eeb2cee9329c29115ace14cc5b9f899e3d6beb136ba826307a727016658919a6f383e1511d698acee81741 + languageName: node + linkType: hard + "globby@npm:^11.1.0": version: 11.1.0 resolution: "globby@npm:11.1.0" @@ -13239,6 +13260,50 @@ __metadata: languageName: node linkType: hard +"markdownlint-cli2-formatter-default@npm:0.0.4": + version: 0.0.4 + resolution: "markdownlint-cli2-formatter-default@npm:0.0.4" + peerDependencies: + markdownlint-cli2: ">=0.0.4" + checksum: 533971d6b04e5ff283af497bf13ba4a18aff582439a36e9fceeb01ab74b432085d1deccfa1e84e585fc7a12f5cd89d15fc6ccb797a8efd25d673d6d3b9a4c076 + languageName: node + linkType: hard + +"markdownlint-cli2@npm:0.8.1": + version: 0.8.1 + resolution: "markdownlint-cli2@npm:0.8.1" + dependencies: + globby: 13.1.4 + markdownlint: 0.29.0 + markdownlint-cli2-formatter-default: 0.0.4 + micromatch: 4.0.5 + strip-json-comments: 5.0.0 + yaml: 2.3.1 + bin: + markdownlint-cli2: markdownlint-cli2.js + markdownlint-cli2-config: markdownlint-cli2-config.js + markdownlint-cli2-fix: markdownlint-cli2-fix.js + checksum: 38464d73d91a1abe1cc43f925112e567ee27eb20f536e4a0c1329e28cea4366db68e9c365127bbd95f2580bf2983ec8ea61e98ece1c868c17994b542e37e495d + languageName: node + linkType: hard + +"markdownlint-micromark@npm:0.1.5": + version: 0.1.5 + resolution: "markdownlint-micromark@npm:0.1.5" + checksum: fc69c340c31a06b46cf358759348a12b60b0080d82406ec1ed2e015e96b664e4075584980cf1bf029287109503ec37d0da012ec67827bc7a21a9f7d0b5a624b8 + languageName: node + linkType: hard + +"markdownlint@npm:0.29.0": + version: 0.29.0 + resolution: "markdownlint@npm:0.29.0" + dependencies: + markdown-it: 13.0.1 + markdownlint-micromark: 0.1.5 + checksum: 5785f5173f553510516bf1f68a0768118dcae3a3a19234f6ed57d5d5a8f5beedcca859593fdcf0d8e90fdccb69fd0e168e77416f5712e04e2062c5bf2dca5612 + languageName: node + linkType: hard + "maxmin@npm:^2.1.0": version: 2.1.0 resolution: "maxmin@npm:2.1.0" @@ -13688,7 +13753,7 @@ __metadata: languageName: node linkType: hard -"micromatch@npm:^4.0.0, micromatch@npm:^4.0.2, micromatch@npm:^4.0.4": +"micromatch@npm:4.0.5, micromatch@npm:^4.0.0, micromatch@npm:^4.0.2, micromatch@npm:^4.0.4": version: 4.0.5 resolution: "micromatch@npm:4.0.5" dependencies: @@ -17660,6 +17725,13 @@ __metadata: languageName: node linkType: hard +"strip-json-comments@npm:5.0.0": + version: 5.0.0 + resolution: "strip-json-comments@npm:5.0.0" + checksum: 99cad07ccc3b86cc7bb8a9274a801b0660cbd595189ad291f6e206b8d7b23d90eed3119cdae44e126d9563796024b3ef0e7de2eeee4634b3b9019bafb62803e7 + languageName: node + linkType: hard + "strip-json-comments@npm:^3.1.0, strip-json-comments@npm:^3.1.1": version: 3.1.1 resolution: "strip-json-comments@npm:3.1.1" @@ -19890,6 +19962,13 @@ __metadata: languageName: node linkType: hard +"yaml@npm:2.3.1": + version: 2.3.1 + resolution: "yaml@npm:2.3.1" + checksum: 2c7bc9a7cd4c9f40d3b0b0a98e370781b68b8b7c4515720869aced2b00d92f5da1762b4ffa947f9e795d6cd6b19f410bd4d15fdd38aca7bd96df59bd9486fb54 + languageName: node + linkType: hard + "yaml@npm:^1.10.0, yaml@npm:^1.10.2, yaml@npm:^1.7.2": version: 1.10.2 resolution: "yaml@npm:1.10.2"