Skip to content

Commit

Permalink
chore: markdown lint, link check, fix lint errors & update emojis
Browse files Browse the repository at this point in the history
  • Loading branch information
jolexxa committed Jul 24, 2024
1 parent 3dd7953 commit 5144e68
Show file tree
Hide file tree
Showing 17 changed files with 338 additions and 72 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Deploy to GitHub Pages
name: 🌎 Deploy to GitHub Pages

on:
# Trigger the workflow every time you push to the `main` branch
Expand Down
12 changes: 12 additions & 0 deletions .github/workflows/markdown_links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: 🔗 Markdown Link Check

on: push

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
folder-path: src/
17 changes: 17 additions & 0 deletions .github/workflows/markdown_lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: 👀 Markdown Lint Check

on: push

jobs:
markdown-lint:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository using git
uses: actions/checkout@v4

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 22

- run: npm run lint
7 changes: 7 additions & 0 deletions .mdlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.34.0/schema/markdownlint-config-schema.json",
"default": true,
"no-inline-html": false,
"line-length": false,
"no-duplicate-heading": false
}
1 change: 1 addition & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"recommendations": [
"astro-build.astro-vscode",
"bradlc.vscode-tailwindcss",
"DavidAnson.vscode-markdownlint",
"unifiedjs.vscode-mdx"
],
"unwantedRecommendations": []
Expand Down
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@
"**/*.tsx",
"**/*.json"
],
"markdownlint.config": {
"MD024": false
},
"tailwindCSS.includeLanguages": {
"plaintext": "html"
}
Expand Down
17 changes: 15 additions & 2 deletions cspell.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
{
"ignorePaths": ["node_modules/**", ".**/"],
"files": ["**/*.md", "**/*.mdx", "**/*.tsx", "**/*.ts", "**/*.json"],
"ignorePaths": [
"node_modules/**",
".**/"
],
"files": [
"**/*.md",
"**/*.mdx",
"**/*.tsx",
"**/*.ts",
"**/*.json"
],
"words": [
"astro",
"astrojs",
"Cupertino",
"fontsource",
"incentivized",
"laboratoria",
"mdlint",
"multiplatform",
"pubspec",
"tailwindcss",
"todos",
"tsconfigs"
Expand Down
194 changes: 194 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"preview": "astro preview",
"astro": "astro",
"type:check": "tsc",
"lint": "mdlint ./src/",
"format": "prettier --write . --ext js,json,jsonc,ts,tsx,jsx,md,mdx",
"format:check": "prettier --check ."
},
Expand All @@ -30,6 +31,7 @@
"typescript": "^5.4.5"
},
"devDependencies": {
"@laboratoria/mdlint": "^1.2.3",
"eslint": "^9.3.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-astro": "^1.2.0",
Expand Down
Loading

0 comments on commit 5144e68

Please sign in to comment.