Merge pull request #124 from mojafa/fix/lint-issues

fixed linting issues and changes some rules

.github/pull_request_template.md

@@ -1,35 +1,49 @@
 ## Writer's Checklist
 
 ### Writing Structure
+
 - [ ] Use short sentences and paragraphs, and include bucket brigades.
 - [ ] Include more than two descriptive H2 headings to organize content.
-- [ ] Capitalize headings according to the AP Stylebook ([use this tool](https://capitalizemytitle.com/style/AP/))
-- [ ] Include an introduction with at least two paragraphs before the first H2 section.
-- [ ] Use appropriate formatting (bold, italic, underline), notes, quotes, TLDRs, and key points.
+- [ ] Capitalize headings according to the AP Stylebook
+      ([use this tool](https://capitalizemytitle.com/style/AP/))
+- [ ] Include an introduction with at least two paragraphs before the first H2
+      section.
+- [ ] Use appropriate formatting (bold, italic, underline), notes, quotes,
+      TLDRs, and key points.
 - [ ] Incorporate `code elements` and `Markdown format` where appropriate.
-- [ ] Ensure at least one visual element per “screen” of the article (screenshots, diagrams, tables, graphs, lists, sidenotes, blockquotes).
+- [ ] Ensure at least one visual element per “screen” of the article
+      (screenshots, diagrams, tables, graphs, lists, sidenotes, blockquotes).
 
 ### Fact-Checking
+
 - [ ] Verify all facts and data points included in the article.
 
 ### Asset Management
+
 - [ ] Save images in the `/assets` folder.
-- [ ] Follow naming conventions: `YYYYMMDD_title_of_the_article_IMG_NAME_NO.png`.
-- [ ] (Optional) Create a GitHub repo for the code referenced in the article and share it.
+- [ ] Follow naming conventions:
+      `YYYYMMDD_title_of_the_article_IMG_NAME_NO.png`.
+- [ ] (Optional) Create a GitHub repo for the code referenced in the article and
+      share it.
 - [ ] (Optional) Include a link to this Loom video in the PR comments.
 
 ### Interlinking
+
 - [ ] Use `CTRL+F` to search for relevant keywords in:
-    - [Daytona Dotfiles Sitemap](https://www.daytona.io/sitemap-dotfiles.xml)
-    - [Daytona Definitions Sitemap](https://www.daytona.io/sitemap-definitions.xml)
+  - [Daytona Dotfiles Sitemap](https://www.daytona.io/sitemap-dotfiles.xml)
+  - [Daytona Definitions Sitemap](https://www.daytona.io/sitemap-definitions.xml)
 - [ ] Interlink keywords using the appropriate URLs.
 
 ### Glossary/Definitions
+
 - [ ] Create new definition in `/defitnitions` folder.
 
 ### Review and Edit
-- [ ] Ensure articles address the needs of the target audience and their search intent.
+
+- [ ] Ensure articles address the needs of the target audience and their search
+      intent.
 - [ ] Read the article out loud to catch any awkward phrasing.
-- [ ] Run the draft through [Grammarly](https://grammarly.com) or a similar grammar tool.
+- [ ] Run the draft through [Grammarly](https://grammarly.com) or a similar
+      grammar tool.
 - [ ] Double-check adherence to the style guide and repository guidelines.
-- [ ] Use the name of the article for the title of the PR.
+- [ ] Use the name of the article for the title of the PR.

.github/workflows/content-check.yml

@@ -46,4 +46,4 @@ jobs:
         fi
 
     - name: Run Markdown Lint
-      run: npx markdownlint '**/*.md'
+      run: npx markdownlint '**/*.md --ignore "node_modules"'

.markdownlint.json

@@ -1,29 +1,39 @@
 {
-    "default": true,
-    "MD001": { "level": 1 },      // Header levels should only increment by one level at a time
-    "MD002": { "level": 1 },      // First header should be a top-level header
-    "MD003": { "style": "atx" },  // Header style (atx or setext)
-    "MD004": { "style": "dash" }, // Unordered list style (asterisk, plus, or dash)
-    "MD005": false,               // Inconsistent indentation for list items at the same level
-    "MD013": false,               // Line length
-    "MD022": true,                // Headings should be surrounded by blank lines
-    "MD023": true,                // Headings must start at the beginning of the line
-    "MD026": false,               // Trailing punctuation in header
-    "MD031": false,               // Fenced code blocks should be surrounded by blank lines
-    "MD032": false,               // Lists should be surrounded by blank lines
-    "MD033": false,               // Allow inline HTML
-    "MD034": true,                // Bare URL used
-    "MD035": { "style": "---" },  // Horizontal rule style
-    "MD036": true,                // Emphasis used instead of a header
-    "MD037": true,                // Spaces inside emphasis markers
-    "MD038": true,                // Spaces inside code span elements
-    "MD039": true,                // Spaces inside link text
-    "MD040": false,               // Fenced code blocks should have a language specified
-    "MD041": { "level": 1 },      // First line in file should be a top-level header
-    "MD042": false,               // No empty links
-    "MD043": false,               // Required heading structure
-    "MD045": false,               // Images should have alternate text
-    "MD046": false,               // Code block style
-    "MD047": false,               // Files should end with a single newline character
-    "MD048": false                // Code fence style
-  }
+  "default": true,
+  "ignores": [
+    "node_modules/**",
+    "dist/**",
+    "build/**",
+    "coverage/**",
+    "**/CHANGELOG.md",
+    "**/LICENSE.md",
+    "**/README.md"
+  ],
+  "MD001": { "level": 1 },
+  "MD002": { "level": 1 },
+  "MD003": { "style": "atx" },
+  "MD004": { "style": "dash" },
+  "MD005": false,
+  "MD013": { "line_length": 300 },
+  "MD022": true,
+  "MD023": true,
+  "MD025": false,
+  "MD026": false,
+  "MD031": false,
+  "MD032": false,
+  "MD033": false,
+  "MD034": true,
+  "MD035": { "style": "---" },
+  "MD036": false,
+  "MD037": true,
+  "MD038": true,
+  "MD039": true,
+  "MD040": false,
+  "MD041": false,
+  "MD042": false,
+  "MD043": false,
+  "MD045": false,
+  "MD046": { "style": "fenced" },
+  "MD047": false,
+  "MD048": false
+}

CODE_OF_CONDUCT.md

@@ -1,4 +1,3 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -18,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
+- Focusing on what is best not just for us as individuals, but for the overall
   community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or advances of
+- The use of sexualized language or imagery, and sexual attention or advances of
   any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
   without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -120,8 +119,8 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.1, available at
 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
 [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
@@ -131,4 +130,4 @@ For answers to common questions about this code of conduct, see the FAQ at
 [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations
+[translations]: https://www.contributor-covenant.org/translations