Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code
TrueChartsClone/.markdownlint.yaml

24 lines
749 B
YAML
Raw Permalink Normal View History

chore(docs): extend linter and apply lint (#3200) * chore(docs): extend linter and apply lint * bump apps to forward docs to websiter
2022-07-17 11:14:52 +00:00
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md004
# Use dash for "Unordered list style"
MD004:
style: dash
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013
# Do not warn for Line length
MD013:
# We can lower this and wrap lines. Markdown does not care.
line_length: 999
chore(docs): add markdownlint and cpell config files (and apply some linting) (#3140) * chore(docs): apply some linting * chore(docs): add markdownlint and cpell config files * remove duplicate key * add extension recommendation * update cspell
2022-07-11 19:13:45 +00:00
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033
# Do not warn for "Inline HTML"
MD033: false
chore(docs): extend linter and apply lint (#3200) * chore(docs): extend linter and apply lint * bump apps to forward docs to websiter
2022-07-17 11:14:52 +00:00
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md036
chore(docs): add markdownlint and cpell config files (and apply some linting) (#3140) * chore(docs): apply some linting * chore(docs): add markdownlint and cpell config files * remove duplicate key * add extension recommendation * update cspell
2022-07-11 19:13:45 +00:00
# Do not warn for "Emphasis used instead of a heading"
MD036: false
chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589) **Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> front matter is supported by all doc sites (including github markdown rendering and is easier to add extra metadata later on, if we want to. ``` --- title: sometitle --- ``` **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._
2023-12-31 14:24:05 +00:00
# https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md024.md
# Do not warn for "Multiple headers with the same content"
MD024:
siblings_only: true